1 /* Text to put at the beginning of the generated file. Probably a license. */
3 /* Generated with cbindgen:0.16.0 */
5 /* Warning, this file is autogenerated by cbindgen. Don't modify this manually. */
13 * An error when accessing the chain via [`Access`].
15 typedef enum LDKAccessError {
17 * The requested chain is unknown.
19 LDKAccessError_UnknownChain,
21 * The requested transaction doesn't exist or hasn't confirmed.
23 LDKAccessError_UnknownTx,
25 * Must be last for serialization purposes
27 LDKAccessError_Sentinel,
31 * An error enum representing a failure to persist a channel monitor update.
33 typedef enum LDKChannelMonitorUpdateErr {
35 * Used to indicate a temporary failure (eg connection to a watchtower or remote backup of
36 * our state failed, but is expected to succeed at some point in the future).
38 * Such a failure will \"freeze\" a channel, preventing us from revoking old states or
39 * submitting new commitment transactions to the counterparty. Once the update(s) which failed
40 * have been successfully applied, ChannelManager::channel_monitor_updated can be used to
41 * restore the channel to an operational state.
43 * Note that a given ChannelManager will *never* re-generate a given ChannelMonitorUpdate. If
44 * you return a TemporaryFailure you must ensure that it is written to disk safely before
45 * writing out the latest ChannelManager state.
47 * Even when a channel has been \"frozen\" updates to the ChannelMonitor can continue to occur
48 * (eg if an inbound HTLC which we forwarded was claimed upstream resulting in us attempting
49 * to claim it on this channel) and those updates must be applied wherever they can be. At
50 * least one such updated ChannelMonitor must be persisted otherwise PermanentFailure should
51 * be returned to get things on-chain ASAP using only the in-memory copy. Obviously updates to
52 * the channel which would invalidate previous ChannelMonitors are not made when a channel has
55 * Note that even if updates made after TemporaryFailure succeed you must still call
56 * channel_monitor_updated to ensure you have the latest monitor and re-enable normal channel
59 * Note that the update being processed here will not be replayed for you when you call
60 * ChannelManager::channel_monitor_updated, so you must store the update itself along
61 * with the persisted ChannelMonitor on your own local disk prior to returning a
62 * TemporaryFailure. You may, of course, employ a journaling approach, storing only the
63 * ChannelMonitorUpdate on disk without updating the monitor itself, replaying the journal at
66 * For deployments where a copy of ChannelMonitors and other local state are backed up in a
67 * remote location (with local copies persisted immediately), it is anticipated that all
68 * updates will return TemporaryFailure until the remote copies could be updated.
70 LDKChannelMonitorUpdateErr_TemporaryFailure,
72 * Used to indicate no further channel monitor updates will be allowed (eg we've moved on to a
73 * different watchtower and cannot update with all watchtowers that were previously informed
76 * At reception of this error, ChannelManager will force-close the channel and return at
77 * least a final ChannelMonitorUpdate::ChannelForceClosed which must be delivered to at
78 * least one ChannelMonitor copy. Revocation secret MUST NOT be released and offchain channel
79 * update must be rejected.
81 * This failure may also signal a failure to update the local persisted copy of one of
82 * the channel monitor instance.
84 * Note that even when you fail a holder commitment transaction update, you must store the
85 * update to ensure you can claim from it in case of a duplicate copy of this ChannelMonitor
86 * broadcasts it (e.g distributed channel-monitor deployment)
88 * In case of distributed watchtowers deployment, the new version must be written to disk, as
89 * state may have been stored but rejected due to a block forcing a commitment broadcast. This
90 * storage is used to claim outputs of rejected state confirmed onchain by another watchtower,
91 * lagging behind on block processing.
93 LDKChannelMonitorUpdateErr_PermanentFailure,
95 * Must be last for serialization purposes
97 LDKChannelMonitorUpdateErr_Sentinel,
98 } LDKChannelMonitorUpdateErr;
101 * An enum that represents the speed at which we want a transaction to confirm used for feerate
104 typedef enum LDKConfirmationTarget {
106 * We are happy with this transaction confirming slowly when feerate drops some.
108 LDKConfirmationTarget_Background,
110 * We'd like this transaction to confirm without major delay, but 12-18 blocks is fine.
112 LDKConfirmationTarget_Normal,
114 * We'd like this transaction to confirm in the next few blocks.
116 LDKConfirmationTarget_HighPriority,
118 * Must be last for serialization purposes
120 LDKConfirmationTarget_Sentinel,
121 } LDKConfirmationTarget;
124 * An enum representing the available verbosity levels of the logger.
126 typedef enum LDKLevel {
128 *Designates logger being silent
132 * Designates very serious errors
136 * Designates hazardous situations
140 * Designates useful information
144 * Designates lower priority information
148 * Designates very low priority, often extremely verbose, information
152 * Must be last for serialization purposes
158 * An enum representing the possible Bitcoin or test networks which we can run on
160 typedef enum LDKNetwork {
162 * The main Bitcoin blockchain.
166 * The testnet3 blockchain.
170 * A local test blockchain.
174 * A blockchain on which blocks are signed instead of mined.
178 * Must be last for serialization purposes
184 * Represents an error returned from libsecp256k1 during validation of some secp256k1 data
186 typedef enum LDKSecp256k1Error {
188 * Signature failed verification
190 LDKSecp256k1Error_IncorrectSignature,
192 * Badly sized message ("messages" are actually fixed-sized digests; see the MESSAGE_SIZE constant)
194 LDKSecp256k1Error_InvalidMessage,
198 LDKSecp256k1Error_InvalidPublicKey,
202 LDKSecp256k1Error_InvalidSignature,
206 LDKSecp256k1Error_InvalidSecretKey,
210 LDKSecp256k1Error_InvalidRecoveryId,
212 * Invalid tweak for add_assign or mul_assign
214 LDKSecp256k1Error_InvalidTweak,
216 * tweak_add_check failed on an xonly public key
218 LDKSecp256k1Error_TweakCheckFailed,
220 * Didn't pass enough memory to context creation with preallocated memory
222 LDKSecp256k1Error_NotEnoughMemory,
224 * Must be last for serialization purposes
226 LDKSecp256k1Error_Sentinel,
230 * A serialized transaction, in (pointer, length) form.
232 * This type optionally owns its own memory, and thus the semantics around access change based on
233 * the `data_is_owned` flag. If `data_is_owned` is set, you must call `Transaction_free` to free
234 * the underlying buffer before the object goes out of scope. If `data_is_owned` is not set, any
235 * access to the buffer after the scope in which the object was provided to you is invalid. eg,
236 * access after you return from the call in which a `!data_is_owned` `Transaction` is provided to
237 * you would be invalid.
239 * Note that, while it may change in the future, because transactions on the Rust side are stored
240 * in a deserialized form, all `Transaction`s generated on the Rust side will have `data_is_owned`
241 * set. Similarly, while it may change in the future, all `Transaction`s you pass to Rust may have
242 * `data_is_owned` either set or unset at your discretion.
244 typedef struct LDKTransaction {
246 * The serialized transaction data.
248 * This is non-const for your convenience, an object passed to Rust is never written to.
252 * The length of the serialized transaction
256 * Whether the data pointed to by `data` should be freed or not.
262 * A dynamically-allocated array of u8s of arbitrary size.
263 * This corresponds to std::vector in C++
265 typedef struct LDKCVec_u8Z {
267 * The elements in the array.
268 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
272 * The number of elements pointed to by `data`.
278 * A transaction output including a scriptPubKey and value.
279 * This type *does* own its own memory, so must be free'd appropriately.
281 typedef struct LDKTxOut {
283 * The script_pubkey in this output
285 struct LDKCVec_u8Z script_pubkey;
287 * The value, in satoshis, of this output
293 * Represents a valid secp256k1 secret key serialized as a 32 byte array.
295 typedef struct LDKSecretKey {
297 * The bytes of the secret key
303 * The contents of CResult_SecretKeyErrorZ
305 typedef union LDKCResult_SecretKeyErrorZPtr {
307 * A pointer to the contents in the success state.
308 * Reading from this pointer when `result_ok` is not set is undefined.
310 struct LDKSecretKey *result;
312 * A pointer to the contents in the error state.
313 * Reading from this pointer when `result_ok` is set is undefined.
315 enum LDKSecp256k1Error *err;
316 } LDKCResult_SecretKeyErrorZPtr;
319 * A CResult_SecretKeyErrorZ represents the result of a fallible operation,
320 * containing a crate::c_types::SecretKey on success and a crate::c_types::Secp256k1Error on failure.
321 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
323 typedef struct LDKCResult_SecretKeyErrorZ {
325 * The contents of this CResult_SecretKeyErrorZ, accessible via either
326 * `err` or `result` depending on the state of `result_ok`.
328 union LDKCResult_SecretKeyErrorZPtr contents;
330 * Whether this CResult_SecretKeyErrorZ represents a success state.
333 } LDKCResult_SecretKeyErrorZ;
336 * Represents a valid secp256k1 public key serialized in "compressed form" as a 33 byte array.
338 typedef struct LDKPublicKey {
340 * The bytes of the public key
342 uint8_t compressed_form[33];
346 * The contents of CResult_PublicKeyErrorZ
348 typedef union LDKCResult_PublicKeyErrorZPtr {
350 * A pointer to the contents in the success state.
351 * Reading from this pointer when `result_ok` is not set is undefined.
353 struct LDKPublicKey *result;
355 * A pointer to the contents in the error state.
356 * Reading from this pointer when `result_ok` is set is undefined.
358 enum LDKSecp256k1Error *err;
359 } LDKCResult_PublicKeyErrorZPtr;
362 * A CResult_PublicKeyErrorZ represents the result of a fallible operation,
363 * containing a crate::c_types::PublicKey on success and a crate::c_types::Secp256k1Error on failure.
364 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
366 typedef struct LDKCResult_PublicKeyErrorZ {
368 * The contents of this CResult_PublicKeyErrorZ, accessible via either
369 * `err` or `result` depending on the state of `result_ok`.
371 union LDKCResult_PublicKeyErrorZPtr contents;
373 * Whether this CResult_PublicKeyErrorZ represents a success state.
376 } LDKCResult_PublicKeyErrorZ;
381 * The set of public keys which are used in the creation of one commitment transaction.
382 * These are derived from the channel base keys and per-commitment data.
384 * A broadcaster key is provided from potential broadcaster of the computed transaction.
385 * A countersignatory key is coming from a protocol participant unable to broadcast the
388 * These keys are assumed to be good, either because the code derived them from
389 * channel basepoints via the new function, or they were obtained via
390 * CommitmentTransaction.trust().keys() because we trusted the source of the
391 * pre-calculated keys.
393 typedef struct MUST_USE_STRUCT LDKTxCreationKeys {
395 * A pointer to the opaque Rust object.
396 * Nearly everywhere, inner must be non-null, however in places where
397 * the Rust equivalent takes an Option, it may be set to null to indicate None.
399 LDKnativeTxCreationKeys *inner;
401 * Indicates that this is the only struct which contains the same pointer.
402 * Rust functions which take ownership of an object provided via an argument require
403 * this to be true and invalidate the object pointed to by inner.
411 * An error in decoding a message or struct.
413 typedef struct MUST_USE_STRUCT LDKDecodeError {
415 * A pointer to the opaque Rust object.
416 * Nearly everywhere, inner must be non-null, however in places where
417 * the Rust equivalent takes an Option, it may be set to null to indicate None.
419 LDKnativeDecodeError *inner;
421 * Indicates that this is the only struct which contains the same pointer.
422 * Rust functions which take ownership of an object provided via an argument require
423 * this to be true and invalidate the object pointed to by inner.
429 * The contents of CResult_TxCreationKeysDecodeErrorZ
431 typedef union LDKCResult_TxCreationKeysDecodeErrorZPtr {
433 * A pointer to the contents in the success state.
434 * Reading from this pointer when `result_ok` is not set is undefined.
436 struct LDKTxCreationKeys *result;
438 * A pointer to the contents in the error state.
439 * Reading from this pointer when `result_ok` is set is undefined.
441 struct LDKDecodeError *err;
442 } LDKCResult_TxCreationKeysDecodeErrorZPtr;
445 * A CResult_TxCreationKeysDecodeErrorZ represents the result of a fallible operation,
446 * containing a crate::ln::chan_utils::TxCreationKeys on success and a crate::ln::msgs::DecodeError on failure.
447 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
449 typedef struct LDKCResult_TxCreationKeysDecodeErrorZ {
451 * The contents of this CResult_TxCreationKeysDecodeErrorZ, accessible via either
452 * `err` or `result` depending on the state of `result_ok`.
454 union LDKCResult_TxCreationKeysDecodeErrorZPtr contents;
456 * Whether this CResult_TxCreationKeysDecodeErrorZ represents a success state.
459 } LDKCResult_TxCreationKeysDecodeErrorZ;
464 * One counterparty's public keys which do not change over the life of a channel.
466 typedef struct MUST_USE_STRUCT LDKChannelPublicKeys {
468 * A pointer to the opaque Rust object.
469 * Nearly everywhere, inner must be non-null, however in places where
470 * the Rust equivalent takes an Option, it may be set to null to indicate None.
472 LDKnativeChannelPublicKeys *inner;
474 * Indicates that this is the only struct which contains the same pointer.
475 * Rust functions which take ownership of an object provided via an argument require
476 * this to be true and invalidate the object pointed to by inner.
479 } LDKChannelPublicKeys;
482 * The contents of CResult_ChannelPublicKeysDecodeErrorZ
484 typedef union LDKCResult_ChannelPublicKeysDecodeErrorZPtr {
486 * A pointer to the contents in the success state.
487 * Reading from this pointer when `result_ok` is not set is undefined.
489 struct LDKChannelPublicKeys *result;
491 * A pointer to the contents in the error state.
492 * Reading from this pointer when `result_ok` is set is undefined.
494 struct LDKDecodeError *err;
495 } LDKCResult_ChannelPublicKeysDecodeErrorZPtr;
498 * A CResult_ChannelPublicKeysDecodeErrorZ represents the result of a fallible operation,
499 * containing a crate::ln::chan_utils::ChannelPublicKeys on success and a crate::ln::msgs::DecodeError on failure.
500 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
502 typedef struct LDKCResult_ChannelPublicKeysDecodeErrorZ {
504 * The contents of this CResult_ChannelPublicKeysDecodeErrorZ, accessible via either
505 * `err` or `result` depending on the state of `result_ok`.
507 union LDKCResult_ChannelPublicKeysDecodeErrorZPtr contents;
509 * Whether this CResult_ChannelPublicKeysDecodeErrorZ represents a success state.
512 } LDKCResult_ChannelPublicKeysDecodeErrorZ;
515 * The contents of CResult_TxCreationKeysErrorZ
517 typedef union LDKCResult_TxCreationKeysErrorZPtr {
519 * A pointer to the contents in the success state.
520 * Reading from this pointer when `result_ok` is not set is undefined.
522 struct LDKTxCreationKeys *result;
524 * A pointer to the contents in the error state.
525 * Reading from this pointer when `result_ok` is set is undefined.
527 enum LDKSecp256k1Error *err;
528 } LDKCResult_TxCreationKeysErrorZPtr;
531 * A CResult_TxCreationKeysErrorZ represents the result of a fallible operation,
532 * containing a crate::ln::chan_utils::TxCreationKeys on success and a crate::c_types::Secp256k1Error on failure.
533 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
535 typedef struct LDKCResult_TxCreationKeysErrorZ {
537 * The contents of this CResult_TxCreationKeysErrorZ, accessible via either
538 * `err` or `result` depending on the state of `result_ok`.
540 union LDKCResult_TxCreationKeysErrorZPtr contents;
542 * Whether this CResult_TxCreationKeysErrorZ represents a success state.
545 } LDKCResult_TxCreationKeysErrorZ;
548 * An enum which can either contain a u32 or not
550 typedef enum LDKCOption_u32Z_Tag {
552 * When we're in this state, this COption_u32Z contains a u32
554 LDKCOption_u32Z_Some,
556 * When we're in this state, this COption_u32Z contains nothing
558 LDKCOption_u32Z_None,
560 * Must be last for serialization purposes
562 LDKCOption_u32Z_Sentinel,
563 } LDKCOption_u32Z_Tag;
565 typedef struct LDKCOption_u32Z {
566 LDKCOption_u32Z_Tag tag;
577 * Information about an HTLC as it appears in a commitment transaction
579 typedef struct MUST_USE_STRUCT LDKHTLCOutputInCommitment {
581 * A pointer to the opaque Rust object.
582 * Nearly everywhere, inner must be non-null, however in places where
583 * the Rust equivalent takes an Option, it may be set to null to indicate None.
585 LDKnativeHTLCOutputInCommitment *inner;
587 * Indicates that this is the only struct which contains the same pointer.
588 * Rust functions which take ownership of an object provided via an argument require
589 * this to be true and invalidate the object pointed to by inner.
592 } LDKHTLCOutputInCommitment;
595 * The contents of CResult_HTLCOutputInCommitmentDecodeErrorZ
597 typedef union LDKCResult_HTLCOutputInCommitmentDecodeErrorZPtr {
599 * A pointer to the contents in the success state.
600 * Reading from this pointer when `result_ok` is not set is undefined.
602 struct LDKHTLCOutputInCommitment *result;
604 * A pointer to the contents in the error state.
605 * Reading from this pointer when `result_ok` is set is undefined.
607 struct LDKDecodeError *err;
608 } LDKCResult_HTLCOutputInCommitmentDecodeErrorZPtr;
611 * A CResult_HTLCOutputInCommitmentDecodeErrorZ represents the result of a fallible operation,
612 * containing a crate::ln::chan_utils::HTLCOutputInCommitment on success and a crate::ln::msgs::DecodeError on failure.
613 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
615 typedef struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ {
617 * The contents of this CResult_HTLCOutputInCommitmentDecodeErrorZ, accessible via either
618 * `err` or `result` depending on the state of `result_ok`.
620 union LDKCResult_HTLCOutputInCommitmentDecodeErrorZPtr contents;
622 * Whether this CResult_HTLCOutputInCommitmentDecodeErrorZ represents a success state.
625 } LDKCResult_HTLCOutputInCommitmentDecodeErrorZ;
630 * Late-bound per-channel counterparty data used to build transactions.
632 typedef struct MUST_USE_STRUCT LDKCounterpartyChannelTransactionParameters {
634 * A pointer to the opaque Rust object.
635 * Nearly everywhere, inner must be non-null, however in places where
636 * the Rust equivalent takes an Option, it may be set to null to indicate None.
638 LDKnativeCounterpartyChannelTransactionParameters *inner;
640 * Indicates that this is the only struct which contains the same pointer.
641 * Rust functions which take ownership of an object provided via an argument require
642 * this to be true and invalidate the object pointed to by inner.
645 } LDKCounterpartyChannelTransactionParameters;
648 * The contents of CResult_CounterpartyChannelTransactionParametersDecodeErrorZ
650 typedef union LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZPtr {
652 * A pointer to the contents in the success state.
653 * Reading from this pointer when `result_ok` is not set is undefined.
655 struct LDKCounterpartyChannelTransactionParameters *result;
657 * A pointer to the contents in the error state.
658 * Reading from this pointer when `result_ok` is set is undefined.
660 struct LDKDecodeError *err;
661 } LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZPtr;
664 * A CResult_CounterpartyChannelTransactionParametersDecodeErrorZ represents the result of a fallible operation,
665 * containing a crate::ln::chan_utils::CounterpartyChannelTransactionParameters on success and a crate::ln::msgs::DecodeError on failure.
666 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
668 typedef struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ {
670 * The contents of this CResult_CounterpartyChannelTransactionParametersDecodeErrorZ, accessible via either
671 * `err` or `result` depending on the state of `result_ok`.
673 union LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZPtr contents;
675 * Whether this CResult_CounterpartyChannelTransactionParametersDecodeErrorZ represents a success state.
678 } LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ;
683 * Per-channel data used to build transactions in conjunction with the per-commitment data (CommitmentTransaction).
684 * The fields are organized by holder/counterparty.
686 * Normally, this is converted to the broadcaster/countersignatory-organized DirectedChannelTransactionParameters
687 * before use, via the as_holder_broadcastable and as_counterparty_broadcastable functions.
689 typedef struct MUST_USE_STRUCT LDKChannelTransactionParameters {
691 * A pointer to the opaque Rust object.
692 * Nearly everywhere, inner must be non-null, however in places where
693 * the Rust equivalent takes an Option, it may be set to null to indicate None.
695 LDKnativeChannelTransactionParameters *inner;
697 * Indicates that this is the only struct which contains the same pointer.
698 * Rust functions which take ownership of an object provided via an argument require
699 * this to be true and invalidate the object pointed to by inner.
702 } LDKChannelTransactionParameters;
705 * The contents of CResult_ChannelTransactionParametersDecodeErrorZ
707 typedef union LDKCResult_ChannelTransactionParametersDecodeErrorZPtr {
709 * A pointer to the contents in the success state.
710 * Reading from this pointer when `result_ok` is not set is undefined.
712 struct LDKChannelTransactionParameters *result;
714 * A pointer to the contents in the error state.
715 * Reading from this pointer when `result_ok` is set is undefined.
717 struct LDKDecodeError *err;
718 } LDKCResult_ChannelTransactionParametersDecodeErrorZPtr;
721 * A CResult_ChannelTransactionParametersDecodeErrorZ represents the result of a fallible operation,
722 * containing a crate::ln::chan_utils::ChannelTransactionParameters on success and a crate::ln::msgs::DecodeError on failure.
723 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
725 typedef struct LDKCResult_ChannelTransactionParametersDecodeErrorZ {
727 * The contents of this CResult_ChannelTransactionParametersDecodeErrorZ, accessible via either
728 * `err` or `result` depending on the state of `result_ok`.
730 union LDKCResult_ChannelTransactionParametersDecodeErrorZPtr contents;
732 * Whether this CResult_ChannelTransactionParametersDecodeErrorZ represents a success state.
735 } LDKCResult_ChannelTransactionParametersDecodeErrorZ;
738 * Represents a secp256k1 signature serialized as two 32-byte numbers
740 typedef struct LDKSignature {
742 * The bytes of the signature in "compact" form
744 uint8_t compact_form[64];
748 * A dynamically-allocated array of crate::c_types::Signatures of arbitrary size.
749 * This corresponds to std::vector in C++
751 typedef struct LDKCVec_SignatureZ {
753 * The elements in the array.
754 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
756 struct LDKSignature *data;
758 * The number of elements pointed to by `data`.
761 } LDKCVec_SignatureZ;
766 * Information needed to build and sign a holder's commitment transaction.
768 * The transaction is only signed once we are ready to broadcast.
770 typedef struct MUST_USE_STRUCT LDKHolderCommitmentTransaction {
772 * A pointer to the opaque Rust object.
773 * Nearly everywhere, inner must be non-null, however in places where
774 * the Rust equivalent takes an Option, it may be set to null to indicate None.
776 LDKnativeHolderCommitmentTransaction *inner;
778 * Indicates that this is the only struct which contains the same pointer.
779 * Rust functions which take ownership of an object provided via an argument require
780 * this to be true and invalidate the object pointed to by inner.
783 } LDKHolderCommitmentTransaction;
786 * The contents of CResult_HolderCommitmentTransactionDecodeErrorZ
788 typedef union LDKCResult_HolderCommitmentTransactionDecodeErrorZPtr {
790 * A pointer to the contents in the success state.
791 * Reading from this pointer when `result_ok` is not set is undefined.
793 struct LDKHolderCommitmentTransaction *result;
795 * A pointer to the contents in the error state.
796 * Reading from this pointer when `result_ok` is set is undefined.
798 struct LDKDecodeError *err;
799 } LDKCResult_HolderCommitmentTransactionDecodeErrorZPtr;
802 * A CResult_HolderCommitmentTransactionDecodeErrorZ represents the result of a fallible operation,
803 * containing a crate::ln::chan_utils::HolderCommitmentTransaction on success and a crate::ln::msgs::DecodeError on failure.
804 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
806 typedef struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ {
808 * The contents of this CResult_HolderCommitmentTransactionDecodeErrorZ, accessible via either
809 * `err` or `result` depending on the state of `result_ok`.
811 union LDKCResult_HolderCommitmentTransactionDecodeErrorZPtr contents;
813 * Whether this CResult_HolderCommitmentTransactionDecodeErrorZ represents a success state.
816 } LDKCResult_HolderCommitmentTransactionDecodeErrorZ;
821 * A pre-built Bitcoin commitment transaction and its txid.
823 typedef struct MUST_USE_STRUCT LDKBuiltCommitmentTransaction {
825 * A pointer to the opaque Rust object.
826 * Nearly everywhere, inner must be non-null, however in places where
827 * the Rust equivalent takes an Option, it may be set to null to indicate None.
829 LDKnativeBuiltCommitmentTransaction *inner;
831 * Indicates that this is the only struct which contains the same pointer.
832 * Rust functions which take ownership of an object provided via an argument require
833 * this to be true and invalidate the object pointed to by inner.
836 } LDKBuiltCommitmentTransaction;
839 * The contents of CResult_BuiltCommitmentTransactionDecodeErrorZ
841 typedef union LDKCResult_BuiltCommitmentTransactionDecodeErrorZPtr {
843 * A pointer to the contents in the success state.
844 * Reading from this pointer when `result_ok` is not set is undefined.
846 struct LDKBuiltCommitmentTransaction *result;
848 * A pointer to the contents in the error state.
849 * Reading from this pointer when `result_ok` is set is undefined.
851 struct LDKDecodeError *err;
852 } LDKCResult_BuiltCommitmentTransactionDecodeErrorZPtr;
855 * A CResult_BuiltCommitmentTransactionDecodeErrorZ represents the result of a fallible operation,
856 * containing a crate::ln::chan_utils::BuiltCommitmentTransaction on success and a crate::ln::msgs::DecodeError on failure.
857 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
859 typedef struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ {
861 * The contents of this CResult_BuiltCommitmentTransactionDecodeErrorZ, accessible via either
862 * `err` or `result` depending on the state of `result_ok`.
864 union LDKCResult_BuiltCommitmentTransactionDecodeErrorZPtr contents;
866 * Whether this CResult_BuiltCommitmentTransactionDecodeErrorZ represents a success state.
869 } LDKCResult_BuiltCommitmentTransactionDecodeErrorZ;
874 * This class tracks the per-transaction information needed to build a commitment transaction and to
875 * actually build it and sign. It is used for holder transactions that we sign only when needed
876 * and for transactions we sign for the counterparty.
878 * This class can be used inside a signer implementation to generate a signature given the relevant
881 typedef struct MUST_USE_STRUCT LDKCommitmentTransaction {
883 * A pointer to the opaque Rust object.
884 * Nearly everywhere, inner must be non-null, however in places where
885 * the Rust equivalent takes an Option, it may be set to null to indicate None.
887 LDKnativeCommitmentTransaction *inner;
889 * Indicates that this is the only struct which contains the same pointer.
890 * Rust functions which take ownership of an object provided via an argument require
891 * this to be true and invalidate the object pointed to by inner.
894 } LDKCommitmentTransaction;
897 * The contents of CResult_CommitmentTransactionDecodeErrorZ
899 typedef union LDKCResult_CommitmentTransactionDecodeErrorZPtr {
901 * A pointer to the contents in the success state.
902 * Reading from this pointer when `result_ok` is not set is undefined.
904 struct LDKCommitmentTransaction *result;
906 * A pointer to the contents in the error state.
907 * Reading from this pointer when `result_ok` is set is undefined.
909 struct LDKDecodeError *err;
910 } LDKCResult_CommitmentTransactionDecodeErrorZPtr;
913 * A CResult_CommitmentTransactionDecodeErrorZ represents the result of a fallible operation,
914 * containing a crate::ln::chan_utils::CommitmentTransaction on success and a crate::ln::msgs::DecodeError on failure.
915 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
917 typedef struct LDKCResult_CommitmentTransactionDecodeErrorZ {
919 * The contents of this CResult_CommitmentTransactionDecodeErrorZ, accessible via either
920 * `err` or `result` depending on the state of `result_ok`.
922 union LDKCResult_CommitmentTransactionDecodeErrorZPtr contents;
924 * Whether this CResult_CommitmentTransactionDecodeErrorZ represents a success state.
927 } LDKCResult_CommitmentTransactionDecodeErrorZ;
932 * A wrapper on CommitmentTransaction indicating that the derived fields (the built bitcoin
933 * transaction and the transaction creation keys) are trusted.
935 * See trust() and verify() functions on CommitmentTransaction.
937 * This structure implements Deref.
939 typedef struct MUST_USE_STRUCT LDKTrustedCommitmentTransaction {
941 * A pointer to the opaque Rust object.
942 * Nearly everywhere, inner must be non-null, however in places where
943 * the Rust equivalent takes an Option, it may be set to null to indicate None.
945 LDKnativeTrustedCommitmentTransaction *inner;
947 * Indicates that this is the only struct which contains the same pointer.
948 * Rust functions which take ownership of an object provided via an argument require
949 * this to be true and invalidate the object pointed to by inner.
952 } LDKTrustedCommitmentTransaction;
955 * The contents of CResult_TrustedCommitmentTransactionNoneZ
957 typedef union LDKCResult_TrustedCommitmentTransactionNoneZPtr {
959 * A pointer to the contents in the success state.
960 * Reading from this pointer when `result_ok` is not set is undefined.
962 struct LDKTrustedCommitmentTransaction *result;
964 * Note that this value is always NULL, as there are no contents in the Err variant
967 } LDKCResult_TrustedCommitmentTransactionNoneZPtr;
970 * A CResult_TrustedCommitmentTransactionNoneZ represents the result of a fallible operation,
971 * containing a crate::ln::chan_utils::TrustedCommitmentTransaction on success and a () on failure.
972 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
974 typedef struct LDKCResult_TrustedCommitmentTransactionNoneZ {
976 * The contents of this CResult_TrustedCommitmentTransactionNoneZ, accessible via either
977 * `err` or `result` depending on the state of `result_ok`.
979 union LDKCResult_TrustedCommitmentTransactionNoneZPtr contents;
981 * Whether this CResult_TrustedCommitmentTransactionNoneZ represents a success state.
984 } LDKCResult_TrustedCommitmentTransactionNoneZ;
987 * The contents of CResult_CVec_SignatureZNoneZ
989 typedef union LDKCResult_CVec_SignatureZNoneZPtr {
991 * A pointer to the contents in the success state.
992 * Reading from this pointer when `result_ok` is not set is undefined.
994 struct LDKCVec_SignatureZ *result;
996 * Note that this value is always NULL, as there are no contents in the Err variant
999 } LDKCResult_CVec_SignatureZNoneZPtr;
1002 * A CResult_CVec_SignatureZNoneZ represents the result of a fallible operation,
1003 * containing a crate::c_types::derived::CVec_SignatureZ on success and a () on failure.
1004 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1006 typedef struct LDKCResult_CVec_SignatureZNoneZ {
1008 * The contents of this CResult_CVec_SignatureZNoneZ, accessible via either
1009 * `err` or `result` depending on the state of `result_ok`.
1011 union LDKCResult_CVec_SignatureZNoneZPtr contents;
1013 * Whether this CResult_CVec_SignatureZNoneZ represents a success state.
1016 } LDKCResult_CVec_SignatureZNoneZ;
1021 * An accept_channel message to be sent or received from a peer
1023 typedef struct MUST_USE_STRUCT LDKAcceptChannel {
1025 * A pointer to the opaque Rust object.
1026 * Nearly everywhere, inner must be non-null, however in places where
1027 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1029 LDKnativeAcceptChannel *inner;
1031 * Indicates that this is the only struct which contains the same pointer.
1032 * Rust functions which take ownership of an object provided via an argument require
1033 * this to be true and invalidate the object pointed to by inner.
1041 * An open_channel message to be sent or received from a peer
1043 typedef struct MUST_USE_STRUCT LDKOpenChannel {
1045 * A pointer to the opaque Rust object.
1046 * Nearly everywhere, inner must be non-null, however in places where
1047 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1049 LDKnativeOpenChannel *inner;
1051 * Indicates that this is the only struct which contains the same pointer.
1052 * Rust functions which take ownership of an object provided via an argument require
1053 * this to be true and invalidate the object pointed to by inner.
1061 * A funding_created message to be sent or received from a peer
1063 typedef struct MUST_USE_STRUCT LDKFundingCreated {
1065 * A pointer to the opaque Rust object.
1066 * Nearly everywhere, inner must be non-null, however in places where
1067 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1069 LDKnativeFundingCreated *inner;
1071 * Indicates that this is the only struct which contains the same pointer.
1072 * Rust functions which take ownership of an object provided via an argument require
1073 * this to be true and invalidate the object pointed to by inner.
1076 } LDKFundingCreated;
1081 * A funding_signed message to be sent or received from a peer
1083 typedef struct MUST_USE_STRUCT LDKFundingSigned {
1085 * A pointer to the opaque Rust object.
1086 * Nearly everywhere, inner must be non-null, however in places where
1087 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1089 LDKnativeFundingSigned *inner;
1091 * Indicates that this is the only struct which contains the same pointer.
1092 * Rust functions which take ownership of an object provided via an argument require
1093 * this to be true and invalidate the object pointed to by inner.
1101 * A funding_locked message to be sent or received from a peer
1103 typedef struct MUST_USE_STRUCT LDKFundingLocked {
1105 * A pointer to the opaque Rust object.
1106 * Nearly everywhere, inner must be non-null, however in places where
1107 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1109 LDKnativeFundingLocked *inner;
1111 * Indicates that this is the only struct which contains the same pointer.
1112 * Rust functions which take ownership of an object provided via an argument require
1113 * this to be true and invalidate the object pointed to by inner.
1121 * An announcement_signatures message to be sent or received from a peer
1123 typedef struct MUST_USE_STRUCT LDKAnnouncementSignatures {
1125 * A pointer to the opaque Rust object.
1126 * Nearly everywhere, inner must be non-null, however in places where
1127 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1129 LDKnativeAnnouncementSignatures *inner;
1131 * Indicates that this is the only struct which contains the same pointer.
1132 * Rust functions which take ownership of an object provided via an argument require
1133 * this to be true and invalidate the object pointed to by inner.
1136 } LDKAnnouncementSignatures;
1141 * Struct used to return values from revoke_and_ack messages, containing a bunch of commitment
1142 * transaction updates if they were pending.
1144 typedef struct MUST_USE_STRUCT LDKCommitmentUpdate {
1146 * A pointer to the opaque Rust object.
1147 * Nearly everywhere, inner must be non-null, however in places where
1148 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1150 LDKnativeCommitmentUpdate *inner;
1152 * Indicates that this is the only struct which contains the same pointer.
1153 * Rust functions which take ownership of an object provided via an argument require
1154 * this to be true and invalidate the object pointed to by inner.
1157 } LDKCommitmentUpdate;
1162 * A revoke_and_ack message to be sent or received from a peer
1164 typedef struct MUST_USE_STRUCT LDKRevokeAndACK {
1166 * A pointer to the opaque Rust object.
1167 * Nearly everywhere, inner must be non-null, however in places where
1168 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1170 LDKnativeRevokeAndACK *inner;
1172 * Indicates that this is the only struct which contains the same pointer.
1173 * Rust functions which take ownership of an object provided via an argument require
1174 * this to be true and invalidate the object pointed to by inner.
1182 * A closing_signed message to be sent or received from a peer
1184 typedef struct MUST_USE_STRUCT LDKClosingSigned {
1186 * A pointer to the opaque Rust object.
1187 * Nearly everywhere, inner must be non-null, however in places where
1188 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1190 LDKnativeClosingSigned *inner;
1192 * Indicates that this is the only struct which contains the same pointer.
1193 * Rust functions which take ownership of an object provided via an argument require
1194 * this to be true and invalidate the object pointed to by inner.
1202 * A shutdown message to be sent or received from a peer
1204 typedef struct MUST_USE_STRUCT LDKShutdown {
1206 * A pointer to the opaque Rust object.
1207 * Nearly everywhere, inner must be non-null, however in places where
1208 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1210 LDKnativeShutdown *inner;
1212 * Indicates that this is the only struct which contains the same pointer.
1213 * Rust functions which take ownership of an object provided via an argument require
1214 * this to be true and invalidate the object pointed to by inner.
1222 * A channel_reestablish message to be sent or received from a peer
1224 typedef struct MUST_USE_STRUCT LDKChannelReestablish {
1226 * A pointer to the opaque Rust object.
1227 * Nearly everywhere, inner must be non-null, however in places where
1228 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1230 LDKnativeChannelReestablish *inner;
1232 * Indicates that this is the only struct which contains the same pointer.
1233 * Rust functions which take ownership of an object provided via an argument require
1234 * this to be true and invalidate the object pointed to by inner.
1237 } LDKChannelReestablish;
1242 * A channel_announcement message to be sent or received from a peer
1244 typedef struct MUST_USE_STRUCT LDKChannelAnnouncement {
1246 * A pointer to the opaque Rust object.
1247 * Nearly everywhere, inner must be non-null, however in places where
1248 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1250 LDKnativeChannelAnnouncement *inner;
1252 * Indicates that this is the only struct which contains the same pointer.
1253 * Rust functions which take ownership of an object provided via an argument require
1254 * this to be true and invalidate the object pointed to by inner.
1257 } LDKChannelAnnouncement;
1262 * A channel_update message to be sent or received from a peer
1264 typedef struct MUST_USE_STRUCT LDKChannelUpdate {
1266 * A pointer to the opaque Rust object.
1267 * Nearly everywhere, inner must be non-null, however in places where
1268 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1270 LDKnativeChannelUpdate *inner;
1272 * Indicates that this is the only struct which contains the same pointer.
1273 * Rust functions which take ownership of an object provided via an argument require
1274 * this to be true and invalidate the object pointed to by inner.
1282 * A node_announcement message to be sent or received from a peer
1284 typedef struct MUST_USE_STRUCT LDKNodeAnnouncement {
1286 * A pointer to the opaque Rust object.
1287 * Nearly everywhere, inner must be non-null, however in places where
1288 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1290 LDKnativeNodeAnnouncement *inner;
1292 * Indicates that this is the only struct which contains the same pointer.
1293 * Rust functions which take ownership of an object provided via an argument require
1294 * this to be true and invalidate the object pointed to by inner.
1297 } LDKNodeAnnouncement;
1302 * An error message to be sent or received from a peer
1304 typedef struct MUST_USE_STRUCT LDKErrorMessage {
1306 * A pointer to the opaque Rust object.
1307 * Nearly everywhere, inner must be non-null, however in places where
1308 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1310 LDKnativeErrorMessage *inner;
1312 * Indicates that this is the only struct which contains the same pointer.
1313 * Rust functions which take ownership of an object provided via an argument require
1314 * this to be true and invalidate the object pointed to by inner.
1320 * Used to put an error message in a LightningError
1322 typedef enum LDKErrorAction_Tag {
1324 * The peer took some action which made us think they were useless. Disconnect them.
1326 LDKErrorAction_DisconnectPeer,
1328 * The peer did something harmless that we weren't able to process, just log and ignore
1330 LDKErrorAction_IgnoreError,
1332 * The peer did something incorrect. Tell them.
1334 LDKErrorAction_SendErrorMessage,
1336 * Must be last for serialization purposes
1338 LDKErrorAction_Sentinel,
1339 } LDKErrorAction_Tag;
1341 typedef struct LDKErrorAction_LDKDisconnectPeer_Body {
1343 * An error message which we should make an effort to send before we disconnect.
1345 struct LDKErrorMessage msg;
1346 } LDKErrorAction_LDKDisconnectPeer_Body;
1348 typedef struct LDKErrorAction_LDKSendErrorMessage_Body {
1350 * The message to send.
1352 struct LDKErrorMessage msg;
1353 } LDKErrorAction_LDKSendErrorMessage_Body;
1355 typedef struct MUST_USE_STRUCT LDKErrorAction {
1356 LDKErrorAction_Tag tag;
1358 LDKErrorAction_LDKDisconnectPeer_Body disconnect_peer;
1359 LDKErrorAction_LDKSendErrorMessage_Body send_error_message;
1364 * The information we received from a peer along the route of a payment we originated. This is
1365 * returned by ChannelMessageHandler::handle_update_fail_htlc to be passed into
1366 * RoutingMessageHandler::handle_htlc_fail_channel_update to update our network map.
1368 typedef enum LDKHTLCFailChannelUpdate_Tag {
1370 * We received an error which included a full ChannelUpdate message.
1372 LDKHTLCFailChannelUpdate_ChannelUpdateMessage,
1374 * We received an error which indicated only that a channel has been closed
1376 LDKHTLCFailChannelUpdate_ChannelClosed,
1378 * We received an error which indicated only that a node has failed
1380 LDKHTLCFailChannelUpdate_NodeFailure,
1382 * Must be last for serialization purposes
1384 LDKHTLCFailChannelUpdate_Sentinel,
1385 } LDKHTLCFailChannelUpdate_Tag;
1387 typedef struct LDKHTLCFailChannelUpdate_LDKChannelUpdateMessage_Body {
1389 * The unwrapped message we received
1391 struct LDKChannelUpdate msg;
1392 } LDKHTLCFailChannelUpdate_LDKChannelUpdateMessage_Body;
1394 typedef struct LDKHTLCFailChannelUpdate_LDKChannelClosed_Body {
1396 * The short_channel_id which has now closed.
1398 uint64_t short_channel_id;
1400 * when this true, this channel should be permanently removed from the
1401 * consideration. Otherwise, this channel can be restored as new channel_update is received
1404 } LDKHTLCFailChannelUpdate_LDKChannelClosed_Body;
1406 typedef struct LDKHTLCFailChannelUpdate_LDKNodeFailure_Body {
1408 * The node_id that has failed.
1410 struct LDKPublicKey node_id;
1412 * when this true, node should be permanently removed from the
1413 * consideration. Otherwise, the channels connected to this node can be
1414 * restored as new channel_update is received
1417 } LDKHTLCFailChannelUpdate_LDKNodeFailure_Body;
1419 typedef struct MUST_USE_STRUCT LDKHTLCFailChannelUpdate {
1420 LDKHTLCFailChannelUpdate_Tag tag;
1422 LDKHTLCFailChannelUpdate_LDKChannelUpdateMessage_Body channel_update_message;
1423 LDKHTLCFailChannelUpdate_LDKChannelClosed_Body channel_closed;
1424 LDKHTLCFailChannelUpdate_LDKNodeFailure_Body node_failure;
1426 } LDKHTLCFailChannelUpdate;
1431 * A query_channel_range message is used to query a peer for channel
1432 * UTXOs in a range of blocks. The recipient of a query makes a best
1433 * effort to reply to the query using one or more reply_channel_range
1436 typedef struct MUST_USE_STRUCT LDKQueryChannelRange {
1438 * A pointer to the opaque Rust object.
1439 * Nearly everywhere, inner must be non-null, however in places where
1440 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1442 LDKnativeQueryChannelRange *inner;
1444 * Indicates that this is the only struct which contains the same pointer.
1445 * Rust functions which take ownership of an object provided via an argument require
1446 * this to be true and invalidate the object pointed to by inner.
1449 } LDKQueryChannelRange;
1454 * A query_short_channel_ids message is used to query a peer for
1455 * routing gossip messages related to one or more short_channel_ids.
1456 * The query recipient will reply with the latest, if available,
1457 * channel_announcement, channel_update and node_announcement messages
1458 * it maintains for the requested short_channel_ids followed by a
1459 * reply_short_channel_ids_end message. The short_channel_ids sent in
1460 * this query are encoded. We only support encoding_type=0 uncompressed
1461 * serialization and do not support encoding_type=1 zlib serialization.
1463 typedef struct MUST_USE_STRUCT LDKQueryShortChannelIds {
1465 * A pointer to the opaque Rust object.
1466 * Nearly everywhere, inner must be non-null, however in places where
1467 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1469 LDKnativeQueryShortChannelIds *inner;
1471 * Indicates that this is the only struct which contains the same pointer.
1472 * Rust functions which take ownership of an object provided via an argument require
1473 * this to be true and invalidate the object pointed to by inner.
1476 } LDKQueryShortChannelIds;
1481 * A reply_channel_range message is a reply to a query_channel_range
1482 * message. Multiple reply_channel_range messages can be sent in reply
1483 * to a single query_channel_range message. The query recipient makes a
1484 * best effort to respond based on their local network view which may
1485 * not be a perfect view of the network. The short_channel_ids in the
1486 * reply are encoded. We only support encoding_type=0 uncompressed
1487 * serialization and do not support encoding_type=1 zlib serialization.
1489 typedef struct MUST_USE_STRUCT LDKReplyChannelRange {
1491 * A pointer to the opaque Rust object.
1492 * Nearly everywhere, inner must be non-null, however in places where
1493 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1495 LDKnativeReplyChannelRange *inner;
1497 * Indicates that this is the only struct which contains the same pointer.
1498 * Rust functions which take ownership of an object provided via an argument require
1499 * this to be true and invalidate the object pointed to by inner.
1502 } LDKReplyChannelRange;
1505 * An event generated by ChannelManager which indicates a message should be sent to a peer (or
1506 * broadcast to most peers).
1507 * These events are handled by PeerManager::process_events if you are using a PeerManager.
1509 typedef enum LDKMessageSendEvent_Tag {
1511 * Used to indicate that we've accepted a channel open and should send the accept_channel
1512 * message provided to the given peer.
1514 LDKMessageSendEvent_SendAcceptChannel,
1516 * Used to indicate that we've initiated a channel open and should send the open_channel
1517 * message provided to the given peer.
1519 LDKMessageSendEvent_SendOpenChannel,
1521 * Used to indicate that a funding_created message should be sent to the peer with the given node_id.
1523 LDKMessageSendEvent_SendFundingCreated,
1525 * Used to indicate that a funding_signed message should be sent to the peer with the given node_id.
1527 LDKMessageSendEvent_SendFundingSigned,
1529 * Used to indicate that a funding_locked message should be sent to the peer with the given node_id.
1531 LDKMessageSendEvent_SendFundingLocked,
1533 * Used to indicate that an announcement_signatures message should be sent to the peer with the given node_id.
1535 LDKMessageSendEvent_SendAnnouncementSignatures,
1537 * Used to indicate that a series of HTLC update messages, as well as a commitment_signed
1538 * message should be sent to the peer with the given node_id.
1540 LDKMessageSendEvent_UpdateHTLCs,
1542 * Used to indicate that a revoke_and_ack message should be sent to the peer with the given node_id.
1544 LDKMessageSendEvent_SendRevokeAndACK,
1546 * Used to indicate that a closing_signed message should be sent to the peer with the given node_id.
1548 LDKMessageSendEvent_SendClosingSigned,
1550 * Used to indicate that a shutdown message should be sent to the peer with the given node_id.
1552 LDKMessageSendEvent_SendShutdown,
1554 * Used to indicate that a channel_reestablish message should be sent to the peer with the given node_id.
1556 LDKMessageSendEvent_SendChannelReestablish,
1558 * Used to indicate that a channel_announcement and channel_update should be broadcast to all
1559 * peers (except the peer with node_id either msg.contents.node_id_1 or msg.contents.node_id_2).
1561 * Note that after doing so, you very likely (unless you did so very recently) want to call
1562 * ChannelManager::broadcast_node_announcement to trigger a BroadcastNodeAnnouncement event.
1563 * This ensures that any nodes which see our channel_announcement also have a relevant
1564 * node_announcement, including relevant feature flags which may be important for routing
1567 LDKMessageSendEvent_BroadcastChannelAnnouncement,
1569 * Used to indicate that a node_announcement should be broadcast to all peers.
1571 LDKMessageSendEvent_BroadcastNodeAnnouncement,
1573 * Used to indicate that a channel_update should be broadcast to all peers.
1575 LDKMessageSendEvent_BroadcastChannelUpdate,
1577 * Broadcast an error downstream to be handled
1579 LDKMessageSendEvent_HandleError,
1581 * When a payment fails we may receive updates back from the hop where it failed. In such
1582 * cases this event is generated so that we can inform the network graph of this information.
1584 LDKMessageSendEvent_PaymentFailureNetworkUpdate,
1586 * Query a peer for channels with funding transaction UTXOs in a block range.
1588 LDKMessageSendEvent_SendChannelRangeQuery,
1590 * Request routing gossip messages from a peer for a list of channels identified by
1591 * their short_channel_ids.
1593 LDKMessageSendEvent_SendShortIdsQuery,
1595 * Sends a reply to a channel range query. This may be one of several SendReplyChannelRange events
1596 * emitted during processing of the query.
1598 LDKMessageSendEvent_SendReplyChannelRange,
1600 * Must be last for serialization purposes
1602 LDKMessageSendEvent_Sentinel,
1603 } LDKMessageSendEvent_Tag;
1605 typedef struct LDKMessageSendEvent_LDKSendAcceptChannel_Body {
1607 * The node_id of the node which should receive this message
1609 struct LDKPublicKey node_id;
1611 * The message which should be sent.
1613 struct LDKAcceptChannel msg;
1614 } LDKMessageSendEvent_LDKSendAcceptChannel_Body;
1616 typedef struct LDKMessageSendEvent_LDKSendOpenChannel_Body {
1618 * The node_id of the node which should receive this message
1620 struct LDKPublicKey node_id;
1622 * The message which should be sent.
1624 struct LDKOpenChannel msg;
1625 } LDKMessageSendEvent_LDKSendOpenChannel_Body;
1627 typedef struct LDKMessageSendEvent_LDKSendFundingCreated_Body {
1629 * The node_id of the node which should receive this message
1631 struct LDKPublicKey node_id;
1633 * The message which should be sent.
1635 struct LDKFundingCreated msg;
1636 } LDKMessageSendEvent_LDKSendFundingCreated_Body;
1638 typedef struct LDKMessageSendEvent_LDKSendFundingSigned_Body {
1640 * The node_id of the node which should receive this message
1642 struct LDKPublicKey node_id;
1644 * The message which should be sent.
1646 struct LDKFundingSigned msg;
1647 } LDKMessageSendEvent_LDKSendFundingSigned_Body;
1649 typedef struct LDKMessageSendEvent_LDKSendFundingLocked_Body {
1651 * The node_id of the node which should receive these message(s)
1653 struct LDKPublicKey node_id;
1655 * The funding_locked message which should be sent.
1657 struct LDKFundingLocked msg;
1658 } LDKMessageSendEvent_LDKSendFundingLocked_Body;
1660 typedef struct LDKMessageSendEvent_LDKSendAnnouncementSignatures_Body {
1662 * The node_id of the node which should receive these message(s)
1664 struct LDKPublicKey node_id;
1666 * The announcement_signatures message which should be sent.
1668 struct LDKAnnouncementSignatures msg;
1669 } LDKMessageSendEvent_LDKSendAnnouncementSignatures_Body;
1671 typedef struct LDKMessageSendEvent_LDKUpdateHTLCs_Body {
1673 * The node_id of the node which should receive these message(s)
1675 struct LDKPublicKey node_id;
1677 * The update messages which should be sent. ALL messages in the struct should be sent!
1679 struct LDKCommitmentUpdate updates;
1680 } LDKMessageSendEvent_LDKUpdateHTLCs_Body;
1682 typedef struct LDKMessageSendEvent_LDKSendRevokeAndACK_Body {
1684 * The node_id of the node which should receive this message
1686 struct LDKPublicKey node_id;
1688 * The message which should be sent.
1690 struct LDKRevokeAndACK msg;
1691 } LDKMessageSendEvent_LDKSendRevokeAndACK_Body;
1693 typedef struct LDKMessageSendEvent_LDKSendClosingSigned_Body {
1695 * The node_id of the node which should receive this message
1697 struct LDKPublicKey node_id;
1699 * The message which should be sent.
1701 struct LDKClosingSigned msg;
1702 } LDKMessageSendEvent_LDKSendClosingSigned_Body;
1704 typedef struct LDKMessageSendEvent_LDKSendShutdown_Body {
1706 * The node_id of the node which should receive this message
1708 struct LDKPublicKey node_id;
1710 * The message which should be sent.
1712 struct LDKShutdown msg;
1713 } LDKMessageSendEvent_LDKSendShutdown_Body;
1715 typedef struct LDKMessageSendEvent_LDKSendChannelReestablish_Body {
1717 * The node_id of the node which should receive this message
1719 struct LDKPublicKey node_id;
1721 * The message which should be sent.
1723 struct LDKChannelReestablish msg;
1724 } LDKMessageSendEvent_LDKSendChannelReestablish_Body;
1726 typedef struct LDKMessageSendEvent_LDKBroadcastChannelAnnouncement_Body {
1728 * The channel_announcement which should be sent.
1730 struct LDKChannelAnnouncement msg;
1732 * The followup channel_update which should be sent.
1734 struct LDKChannelUpdate update_msg;
1735 } LDKMessageSendEvent_LDKBroadcastChannelAnnouncement_Body;
1737 typedef struct LDKMessageSendEvent_LDKBroadcastNodeAnnouncement_Body {
1739 * The node_announcement which should be sent.
1741 struct LDKNodeAnnouncement msg;
1742 } LDKMessageSendEvent_LDKBroadcastNodeAnnouncement_Body;
1744 typedef struct LDKMessageSendEvent_LDKBroadcastChannelUpdate_Body {
1746 * The channel_update which should be sent.
1748 struct LDKChannelUpdate msg;
1749 } LDKMessageSendEvent_LDKBroadcastChannelUpdate_Body;
1751 typedef struct LDKMessageSendEvent_LDKHandleError_Body {
1753 * The node_id of the node which should receive this message
1755 struct LDKPublicKey node_id;
1757 * The action which should be taken.
1759 struct LDKErrorAction action;
1760 } LDKMessageSendEvent_LDKHandleError_Body;
1762 typedef struct LDKMessageSendEvent_LDKPaymentFailureNetworkUpdate_Body {
1764 * The channel/node update which should be sent to NetGraphMsgHandler
1766 struct LDKHTLCFailChannelUpdate update;
1767 } LDKMessageSendEvent_LDKPaymentFailureNetworkUpdate_Body;
1769 typedef struct LDKMessageSendEvent_LDKSendChannelRangeQuery_Body {
1771 * The node_id of this message recipient
1773 struct LDKPublicKey node_id;
1775 * The query_channel_range which should be sent.
1777 struct LDKQueryChannelRange msg;
1778 } LDKMessageSendEvent_LDKSendChannelRangeQuery_Body;
1780 typedef struct LDKMessageSendEvent_LDKSendShortIdsQuery_Body {
1782 * The node_id of this message recipient
1784 struct LDKPublicKey node_id;
1786 * The query_short_channel_ids which should be sent.
1788 struct LDKQueryShortChannelIds msg;
1789 } LDKMessageSendEvent_LDKSendShortIdsQuery_Body;
1791 typedef struct LDKMessageSendEvent_LDKSendReplyChannelRange_Body {
1793 * The node_id of this message recipient
1795 struct LDKPublicKey node_id;
1797 * The reply_channel_range which should be sent.
1799 struct LDKReplyChannelRange msg;
1800 } LDKMessageSendEvent_LDKSendReplyChannelRange_Body;
1802 typedef struct MUST_USE_STRUCT LDKMessageSendEvent {
1803 LDKMessageSendEvent_Tag tag;
1805 LDKMessageSendEvent_LDKSendAcceptChannel_Body send_accept_channel;
1806 LDKMessageSendEvent_LDKSendOpenChannel_Body send_open_channel;
1807 LDKMessageSendEvent_LDKSendFundingCreated_Body send_funding_created;
1808 LDKMessageSendEvent_LDKSendFundingSigned_Body send_funding_signed;
1809 LDKMessageSendEvent_LDKSendFundingLocked_Body send_funding_locked;
1810 LDKMessageSendEvent_LDKSendAnnouncementSignatures_Body send_announcement_signatures;
1811 LDKMessageSendEvent_LDKUpdateHTLCs_Body update_htl_cs;
1812 LDKMessageSendEvent_LDKSendRevokeAndACK_Body send_revoke_and_ack;
1813 LDKMessageSendEvent_LDKSendClosingSigned_Body send_closing_signed;
1814 LDKMessageSendEvent_LDKSendShutdown_Body send_shutdown;
1815 LDKMessageSendEvent_LDKSendChannelReestablish_Body send_channel_reestablish;
1816 LDKMessageSendEvent_LDKBroadcastChannelAnnouncement_Body broadcast_channel_announcement;
1817 LDKMessageSendEvent_LDKBroadcastNodeAnnouncement_Body broadcast_node_announcement;
1818 LDKMessageSendEvent_LDKBroadcastChannelUpdate_Body broadcast_channel_update;
1819 LDKMessageSendEvent_LDKHandleError_Body handle_error;
1820 LDKMessageSendEvent_LDKPaymentFailureNetworkUpdate_Body payment_failure_network_update;
1821 LDKMessageSendEvent_LDKSendChannelRangeQuery_Body send_channel_range_query;
1822 LDKMessageSendEvent_LDKSendShortIdsQuery_Body send_short_ids_query;
1823 LDKMessageSendEvent_LDKSendReplyChannelRange_Body send_reply_channel_range;
1825 } LDKMessageSendEvent;
1828 * A dynamically-allocated array of crate::util::events::MessageSendEvents of arbitrary size.
1829 * This corresponds to std::vector in C++
1831 typedef struct LDKCVec_MessageSendEventZ {
1833 * The elements in the array.
1834 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
1836 struct LDKMessageSendEvent *data;
1838 * The number of elements pointed to by `data`.
1841 } LDKCVec_MessageSendEventZ;
1846 * An Err type for failure to process messages.
1848 typedef struct MUST_USE_STRUCT LDKLightningError {
1850 * A pointer to the opaque Rust object.
1851 * Nearly everywhere, inner must be non-null, however in places where
1852 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1854 LDKnativeLightningError *inner;
1856 * Indicates that this is the only struct which contains the same pointer.
1857 * Rust functions which take ownership of an object provided via an argument require
1858 * this to be true and invalidate the object pointed to by inner.
1861 } LDKLightningError;
1864 * The contents of CResult_boolLightningErrorZ
1866 typedef union LDKCResult_boolLightningErrorZPtr {
1868 * A pointer to the contents in the success state.
1869 * Reading from this pointer when `result_ok` is not set is undefined.
1873 * A pointer to the contents in the error state.
1874 * Reading from this pointer when `result_ok` is set is undefined.
1876 struct LDKLightningError *err;
1877 } LDKCResult_boolLightningErrorZPtr;
1880 * A CResult_boolLightningErrorZ represents the result of a fallible operation,
1881 * containing a bool on success and a crate::ln::msgs::LightningError on failure.
1882 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1884 typedef struct LDKCResult_boolLightningErrorZ {
1886 * The contents of this CResult_boolLightningErrorZ, accessible via either
1887 * `err` or `result` depending on the state of `result_ok`.
1889 union LDKCResult_boolLightningErrorZPtr contents;
1891 * Whether this CResult_boolLightningErrorZ represents a success state.
1894 } LDKCResult_boolLightningErrorZ;
1897 * A tuple of 3 elements. See the individual fields for the types contained.
1899 typedef struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ {
1901 * The element at position 0
1903 struct LDKChannelAnnouncement a;
1905 * The element at position 1
1907 struct LDKChannelUpdate b;
1909 * The element at position 2
1911 struct LDKChannelUpdate c;
1912 } LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ;
1915 * A dynamically-allocated array of crate::c_types::derived::C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZs of arbitrary size.
1916 * This corresponds to std::vector in C++
1918 typedef struct LDKCVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ {
1920 * The elements in the array.
1921 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
1923 struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ *data;
1925 * The number of elements pointed to by `data`.
1928 } LDKCVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ;
1931 * A dynamically-allocated array of crate::ln::msgs::NodeAnnouncements of arbitrary size.
1932 * This corresponds to std::vector in C++
1934 typedef struct LDKCVec_NodeAnnouncementZ {
1936 * The elements in the array.
1937 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
1939 struct LDKNodeAnnouncement *data;
1941 * The number of elements pointed to by `data`.
1944 } LDKCVec_NodeAnnouncementZ;
1947 * The contents of CResult_NoneLightningErrorZ
1949 typedef union LDKCResult_NoneLightningErrorZPtr {
1951 * Note that this value is always NULL, as there are no contents in the OK variant
1955 * A pointer to the contents in the error state.
1956 * Reading from this pointer when `result_ok` is set is undefined.
1958 struct LDKLightningError *err;
1959 } LDKCResult_NoneLightningErrorZPtr;
1962 * A CResult_NoneLightningErrorZ represents the result of a fallible operation,
1963 * containing a () on success and a crate::ln::msgs::LightningError on failure.
1964 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1966 typedef struct LDKCResult_NoneLightningErrorZ {
1968 * The contents of this CResult_NoneLightningErrorZ, accessible via either
1969 * `err` or `result` depending on the state of `result_ok`.
1971 union LDKCResult_NoneLightningErrorZPtr contents;
1973 * Whether this CResult_NoneLightningErrorZ represents a success state.
1976 } LDKCResult_NoneLightningErrorZ;
1979 * A dynamically-allocated array of crate::c_types::PublicKeys of arbitrary size.
1980 * This corresponds to std::vector in C++
1982 typedef struct LDKCVec_PublicKeyZ {
1984 * The elements in the array.
1985 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
1987 struct LDKPublicKey *data;
1989 * The number of elements pointed to by `data`.
1992 } LDKCVec_PublicKeyZ;
1997 * Error for PeerManager errors. If you get one of these, you must disconnect the socket and
1998 * generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
2001 typedef struct MUST_USE_STRUCT LDKPeerHandleError {
2003 * A pointer to the opaque Rust object.
2004 * Nearly everywhere, inner must be non-null, however in places where
2005 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2007 LDKnativePeerHandleError *inner;
2009 * Indicates that this is the only struct which contains the same pointer.
2010 * Rust functions which take ownership of an object provided via an argument require
2011 * this to be true and invalidate the object pointed to by inner.
2014 } LDKPeerHandleError;
2017 * The contents of CResult_CVec_u8ZPeerHandleErrorZ
2019 typedef union LDKCResult_CVec_u8ZPeerHandleErrorZPtr {
2021 * A pointer to the contents in the success state.
2022 * Reading from this pointer when `result_ok` is not set is undefined.
2024 struct LDKCVec_u8Z *result;
2026 * A pointer to the contents in the error state.
2027 * Reading from this pointer when `result_ok` is set is undefined.
2029 struct LDKPeerHandleError *err;
2030 } LDKCResult_CVec_u8ZPeerHandleErrorZPtr;
2033 * A CResult_CVec_u8ZPeerHandleErrorZ represents the result of a fallible operation,
2034 * containing a crate::c_types::derived::CVec_u8Z on success and a crate::ln::peer_handler::PeerHandleError on failure.
2035 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
2037 typedef struct LDKCResult_CVec_u8ZPeerHandleErrorZ {
2039 * The contents of this CResult_CVec_u8ZPeerHandleErrorZ, accessible via either
2040 * `err` or `result` depending on the state of `result_ok`.
2042 union LDKCResult_CVec_u8ZPeerHandleErrorZPtr contents;
2044 * Whether this CResult_CVec_u8ZPeerHandleErrorZ represents a success state.
2047 } LDKCResult_CVec_u8ZPeerHandleErrorZ;
2050 * The contents of CResult_NonePeerHandleErrorZ
2052 typedef union LDKCResult_NonePeerHandleErrorZPtr {
2054 * Note that this value is always NULL, as there are no contents in the OK variant
2058 * A pointer to the contents in the error state.
2059 * Reading from this pointer when `result_ok` is set is undefined.
2061 struct LDKPeerHandleError *err;
2062 } LDKCResult_NonePeerHandleErrorZPtr;
2065 * A CResult_NonePeerHandleErrorZ represents the result of a fallible operation,
2066 * containing a () on success and a crate::ln::peer_handler::PeerHandleError on failure.
2067 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
2069 typedef struct LDKCResult_NonePeerHandleErrorZ {
2071 * The contents of this CResult_NonePeerHandleErrorZ, accessible via either
2072 * `err` or `result` depending on the state of `result_ok`.
2074 union LDKCResult_NonePeerHandleErrorZPtr contents;
2076 * Whether this CResult_NonePeerHandleErrorZ represents a success state.
2079 } LDKCResult_NonePeerHandleErrorZ;
2082 * The contents of CResult_boolPeerHandleErrorZ
2084 typedef union LDKCResult_boolPeerHandleErrorZPtr {
2086 * A pointer to the contents in the success state.
2087 * Reading from this pointer when `result_ok` is not set is undefined.
2091 * A pointer to the contents in the error state.
2092 * Reading from this pointer when `result_ok` is set is undefined.
2094 struct LDKPeerHandleError *err;
2095 } LDKCResult_boolPeerHandleErrorZPtr;
2098 * A CResult_boolPeerHandleErrorZ represents the result of a fallible operation,
2099 * containing a bool on success and a crate::ln::peer_handler::PeerHandleError on failure.
2100 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
2102 typedef struct LDKCResult_boolPeerHandleErrorZ {
2104 * The contents of this CResult_boolPeerHandleErrorZ, accessible via either
2105 * `err` or `result` depending on the state of `result_ok`.
2107 union LDKCResult_boolPeerHandleErrorZPtr contents;
2109 * Whether this CResult_boolPeerHandleErrorZ represents a success state.
2112 } LDKCResult_boolPeerHandleErrorZ;
2117 * Features used within an `init` message.
2119 typedef struct MUST_USE_STRUCT LDKInitFeatures {
2121 * A pointer to the opaque Rust object.
2122 * Nearly everywhere, inner must be non-null, however in places where
2123 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2125 LDKnativeInitFeatures *inner;
2127 * Indicates that this is the only struct which contains the same pointer.
2128 * Rust functions which take ownership of an object provided via an argument require
2129 * this to be true and invalidate the object pointed to by inner.
2135 * The contents of CResult_InitFeaturesDecodeErrorZ
2137 typedef union LDKCResult_InitFeaturesDecodeErrorZPtr {
2139 * A pointer to the contents in the success state.
2140 * Reading from this pointer when `result_ok` is not set is undefined.
2142 struct LDKInitFeatures *result;
2144 * A pointer to the contents in the error state.
2145 * Reading from this pointer when `result_ok` is set is undefined.
2147 struct LDKDecodeError *err;
2148 } LDKCResult_InitFeaturesDecodeErrorZPtr;
2151 * A CResult_InitFeaturesDecodeErrorZ represents the result of a fallible operation,
2152 * containing a crate::ln::features::InitFeatures on success and a crate::ln::msgs::DecodeError on failure.
2153 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
2155 typedef struct LDKCResult_InitFeaturesDecodeErrorZ {
2157 * The contents of this CResult_InitFeaturesDecodeErrorZ, accessible via either
2158 * `err` or `result` depending on the state of `result_ok`.
2160 union LDKCResult_InitFeaturesDecodeErrorZPtr contents;
2162 * Whether this CResult_InitFeaturesDecodeErrorZ represents a success state.
2165 } LDKCResult_InitFeaturesDecodeErrorZ;
2170 * Features used within a `node_announcement` message.
2172 typedef struct MUST_USE_STRUCT LDKNodeFeatures {
2174 * A pointer to the opaque Rust object.
2175 * Nearly everywhere, inner must be non-null, however in places where
2176 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2178 LDKnativeNodeFeatures *inner;
2180 * Indicates that this is the only struct which contains the same pointer.
2181 * Rust functions which take ownership of an object provided via an argument require
2182 * this to be true and invalidate the object pointed to by inner.
2188 * The contents of CResult_NodeFeaturesDecodeErrorZ
2190 typedef union LDKCResult_NodeFeaturesDecodeErrorZPtr {
2192 * A pointer to the contents in the success state.
2193 * Reading from this pointer when `result_ok` is not set is undefined.
2195 struct LDKNodeFeatures *result;
2197 * A pointer to the contents in the error state.
2198 * Reading from this pointer when `result_ok` is set is undefined.
2200 struct LDKDecodeError *err;
2201 } LDKCResult_NodeFeaturesDecodeErrorZPtr;
2204 * A CResult_NodeFeaturesDecodeErrorZ represents the result of a fallible operation,
2205 * containing a crate::ln::features::NodeFeatures on success and a crate::ln::msgs::DecodeError on failure.
2206 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
2208 typedef struct LDKCResult_NodeFeaturesDecodeErrorZ {
2210 * The contents of this CResult_NodeFeaturesDecodeErrorZ, accessible via either
2211 * `err` or `result` depending on the state of `result_ok`.
2213 union LDKCResult_NodeFeaturesDecodeErrorZPtr contents;
2215 * Whether this CResult_NodeFeaturesDecodeErrorZ represents a success state.
2218 } LDKCResult_NodeFeaturesDecodeErrorZ;
2223 * Features used within a `channel_announcement` message.
2225 typedef struct MUST_USE_STRUCT LDKChannelFeatures {
2227 * A pointer to the opaque Rust object.
2228 * Nearly everywhere, inner must be non-null, however in places where
2229 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2231 LDKnativeChannelFeatures *inner;
2233 * Indicates that this is the only struct which contains the same pointer.
2234 * Rust functions which take ownership of an object provided via an argument require
2235 * this to be true and invalidate the object pointed to by inner.
2238 } LDKChannelFeatures;
2241 * The contents of CResult_ChannelFeaturesDecodeErrorZ
2243 typedef union LDKCResult_ChannelFeaturesDecodeErrorZPtr {
2245 * A pointer to the contents in the success state.
2246 * Reading from this pointer when `result_ok` is not set is undefined.
2248 struct LDKChannelFeatures *result;
2250 * A pointer to the contents in the error state.
2251 * Reading from this pointer when `result_ok` is set is undefined.
2253 struct LDKDecodeError *err;
2254 } LDKCResult_ChannelFeaturesDecodeErrorZPtr;
2257 * A CResult_ChannelFeaturesDecodeErrorZ represents the result of a fallible operation,
2258 * containing a crate::ln::features::ChannelFeatures on success and a crate::ln::msgs::DecodeError on failure.
2259 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
2261 typedef struct LDKCResult_ChannelFeaturesDecodeErrorZ {
2263 * The contents of this CResult_ChannelFeaturesDecodeErrorZ, accessible via either
2264 * `err` or `result` depending on the state of `result_ok`.
2266 union LDKCResult_ChannelFeaturesDecodeErrorZPtr contents;
2268 * Whether this CResult_ChannelFeaturesDecodeErrorZ represents a success state.
2271 } LDKCResult_ChannelFeaturesDecodeErrorZ;
2276 * Features used within an invoice.
2278 typedef struct MUST_USE_STRUCT LDKInvoiceFeatures {
2280 * A pointer to the opaque Rust object.
2281 * Nearly everywhere, inner must be non-null, however in places where
2282 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2284 LDKnativeInvoiceFeatures *inner;
2286 * Indicates that this is the only struct which contains the same pointer.
2287 * Rust functions which take ownership of an object provided via an argument require
2288 * this to be true and invalidate the object pointed to by inner.
2291 } LDKInvoiceFeatures;
2294 * The contents of CResult_InvoiceFeaturesDecodeErrorZ
2296 typedef union LDKCResult_InvoiceFeaturesDecodeErrorZPtr {
2298 * A pointer to the contents in the success state.
2299 * Reading from this pointer when `result_ok` is not set is undefined.
2301 struct LDKInvoiceFeatures *result;
2303 * A pointer to the contents in the error state.
2304 * Reading from this pointer when `result_ok` is set is undefined.
2306 struct LDKDecodeError *err;
2307 } LDKCResult_InvoiceFeaturesDecodeErrorZPtr;
2310 * A CResult_InvoiceFeaturesDecodeErrorZ represents the result of a fallible operation,
2311 * containing a crate::ln::features::InvoiceFeatures on success and a crate::ln::msgs::DecodeError on failure.
2312 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
2314 typedef struct LDKCResult_InvoiceFeaturesDecodeErrorZ {
2316 * The contents of this CResult_InvoiceFeaturesDecodeErrorZ, accessible via either
2317 * `err` or `result` depending on the state of `result_ok`.
2319 union LDKCResult_InvoiceFeaturesDecodeErrorZPtr contents;
2321 * Whether this CResult_InvoiceFeaturesDecodeErrorZ represents a success state.
2324 } LDKCResult_InvoiceFeaturesDecodeErrorZ;
2329 * Options which apply on a per-channel basis and may change at runtime or based on negotiation
2330 * with our counterparty.
2332 typedef struct MUST_USE_STRUCT LDKChannelConfig {
2334 * A pointer to the opaque Rust object.
2335 * Nearly everywhere, inner must be non-null, however in places where
2336 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2338 LDKnativeChannelConfig *inner;
2340 * Indicates that this is the only struct which contains the same pointer.
2341 * Rust functions which take ownership of an object provided via an argument require
2342 * this to be true and invalidate the object pointed to by inner.
2348 * The contents of CResult_ChannelConfigDecodeErrorZ
2350 typedef union LDKCResult_ChannelConfigDecodeErrorZPtr {
2352 * A pointer to the contents in the success state.
2353 * Reading from this pointer when `result_ok` is not set is undefined.
2355 struct LDKChannelConfig *result;
2357 * A pointer to the contents in the error state.
2358 * Reading from this pointer when `result_ok` is set is undefined.
2360 struct LDKDecodeError *err;
2361 } LDKCResult_ChannelConfigDecodeErrorZPtr;
2364 * A CResult_ChannelConfigDecodeErrorZ represents the result of a fallible operation,
2365 * containing a crate::util::config::ChannelConfig on success and a crate::ln::msgs::DecodeError on failure.
2366 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
2368 typedef struct LDKCResult_ChannelConfigDecodeErrorZ {
2370 * The contents of this CResult_ChannelConfigDecodeErrorZ, accessible via either
2371 * `err` or `result` depending on the state of `result_ok`.
2373 union LDKCResult_ChannelConfigDecodeErrorZPtr contents;
2375 * Whether this CResult_ChannelConfigDecodeErrorZ represents a success state.
2378 } LDKCResult_ChannelConfigDecodeErrorZ;
2381 * An enum which can either contain a u64 or not
2383 typedef enum LDKCOption_u64Z_Tag {
2385 * When we're in this state, this COption_u64Z contains a u64
2387 LDKCOption_u64Z_Some,
2389 * When we're in this state, this COption_u64Z contains nothing
2391 LDKCOption_u64Z_None,
2393 * Must be last for serialization purposes
2395 LDKCOption_u64Z_Sentinel,
2396 } LDKCOption_u64Z_Tag;
2398 typedef struct LDKCOption_u64Z {
2399 LDKCOption_u64Z_Tag tag;
2410 * Details about one direction of a channel. Received
2411 * within a channel update.
2413 typedef struct MUST_USE_STRUCT LDKDirectionalChannelInfo {
2415 * A pointer to the opaque Rust object.
2416 * Nearly everywhere, inner must be non-null, however in places where
2417 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2419 LDKnativeDirectionalChannelInfo *inner;
2421 * Indicates that this is the only struct which contains the same pointer.
2422 * Rust functions which take ownership of an object provided via an argument require
2423 * this to be true and invalidate the object pointed to by inner.
2426 } LDKDirectionalChannelInfo;
2429 * The contents of CResult_DirectionalChannelInfoDecodeErrorZ
2431 typedef union LDKCResult_DirectionalChannelInfoDecodeErrorZPtr {
2433 * A pointer to the contents in the success state.
2434 * Reading from this pointer when `result_ok` is not set is undefined.
2436 struct LDKDirectionalChannelInfo *result;
2438 * A pointer to the contents in the error state.
2439 * Reading from this pointer when `result_ok` is set is undefined.
2441 struct LDKDecodeError *err;
2442 } LDKCResult_DirectionalChannelInfoDecodeErrorZPtr;
2445 * A CResult_DirectionalChannelInfoDecodeErrorZ represents the result of a fallible operation,
2446 * containing a crate::routing::network_graph::DirectionalChannelInfo on success and a crate::ln::msgs::DecodeError on failure.
2447 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
2449 typedef struct LDKCResult_DirectionalChannelInfoDecodeErrorZ {
2451 * The contents of this CResult_DirectionalChannelInfoDecodeErrorZ, accessible via either
2452 * `err` or `result` depending on the state of `result_ok`.
2454 union LDKCResult_DirectionalChannelInfoDecodeErrorZPtr contents;
2456 * Whether this CResult_DirectionalChannelInfoDecodeErrorZ represents a success state.
2459 } LDKCResult_DirectionalChannelInfoDecodeErrorZ;
2464 * Details about a channel (both directions).
2465 * Received within a channel announcement.
2467 typedef struct MUST_USE_STRUCT LDKChannelInfo {
2469 * A pointer to the opaque Rust object.
2470 * Nearly everywhere, inner must be non-null, however in places where
2471 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2473 LDKnativeChannelInfo *inner;
2475 * Indicates that this is the only struct which contains the same pointer.
2476 * Rust functions which take ownership of an object provided via an argument require
2477 * this to be true and invalidate the object pointed to by inner.
2483 * The contents of CResult_ChannelInfoDecodeErrorZ
2485 typedef union LDKCResult_ChannelInfoDecodeErrorZPtr {
2487 * A pointer to the contents in the success state.
2488 * Reading from this pointer when `result_ok` is not set is undefined.
2490 struct LDKChannelInfo *result;
2492 * A pointer to the contents in the error state.
2493 * Reading from this pointer when `result_ok` is set is undefined.
2495 struct LDKDecodeError *err;
2496 } LDKCResult_ChannelInfoDecodeErrorZPtr;
2499 * A CResult_ChannelInfoDecodeErrorZ represents the result of a fallible operation,
2500 * containing a crate::routing::network_graph::ChannelInfo on success and a crate::ln::msgs::DecodeError on failure.
2501 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
2503 typedef struct LDKCResult_ChannelInfoDecodeErrorZ {
2505 * The contents of this CResult_ChannelInfoDecodeErrorZ, accessible via either
2506 * `err` or `result` depending on the state of `result_ok`.
2508 union LDKCResult_ChannelInfoDecodeErrorZPtr contents;
2510 * Whether this CResult_ChannelInfoDecodeErrorZ represents a success state.
2513 } LDKCResult_ChannelInfoDecodeErrorZ;
2518 * Fees for routing via a given channel or a node
2520 typedef struct MUST_USE_STRUCT LDKRoutingFees {
2522 * A pointer to the opaque Rust object.
2523 * Nearly everywhere, inner must be non-null, however in places where
2524 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2526 LDKnativeRoutingFees *inner;
2528 * Indicates that this is the only struct which contains the same pointer.
2529 * Rust functions which take ownership of an object provided via an argument require
2530 * this to be true and invalidate the object pointed to by inner.
2536 * The contents of CResult_RoutingFeesDecodeErrorZ
2538 typedef union LDKCResult_RoutingFeesDecodeErrorZPtr {
2540 * A pointer to the contents in the success state.
2541 * Reading from this pointer when `result_ok` is not set is undefined.
2543 struct LDKRoutingFees *result;
2545 * A pointer to the contents in the error state.
2546 * Reading from this pointer when `result_ok` is set is undefined.
2548 struct LDKDecodeError *err;
2549 } LDKCResult_RoutingFeesDecodeErrorZPtr;
2552 * A CResult_RoutingFeesDecodeErrorZ represents the result of a fallible operation,
2553 * containing a crate::routing::network_graph::RoutingFees on success and a crate::ln::msgs::DecodeError on failure.
2554 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
2556 typedef struct LDKCResult_RoutingFeesDecodeErrorZ {
2558 * The contents of this CResult_RoutingFeesDecodeErrorZ, accessible via either
2559 * `err` or `result` depending on the state of `result_ok`.
2561 union LDKCResult_RoutingFeesDecodeErrorZPtr contents;
2563 * Whether this CResult_RoutingFeesDecodeErrorZ represents a success state.
2566 } LDKCResult_RoutingFeesDecodeErrorZ;
2569 * A 4-byte byte array.
2571 typedef struct LDKFourBytes {
2579 * A 16-byte byte array.
2581 typedef struct LDKSixteenBytes {
2589 * A 10-byte byte array.
2591 typedef struct LDKTenBytes {
2599 * Arbitrary 32 bytes, which could represent one of a few different things. You probably want to
2600 * look up the corresponding function in rust-lightning's docs.
2602 typedef struct LDKThirtyTwoBytes {
2604 * The thirty-two bytes
2607 } LDKThirtyTwoBytes;
2610 * An address which can be used to connect to a remote peer
2612 typedef enum LDKNetAddress_Tag {
2614 * An IPv4 address/port on which the peer is listening.
2618 * An IPv6 address/port on which the peer is listening.
2622 * An old-style Tor onion address/port on which the peer is listening.
2624 LDKNetAddress_OnionV2,
2626 * A new-style Tor onion address/port on which the peer is listening.
2627 * To create the human-readable \"hostname\", concatenate ed25519_pubkey, checksum, and version,
2628 * wrap as base32 and append \".onion\".
2630 LDKNetAddress_OnionV3,
2632 * Must be last for serialization purposes
2634 LDKNetAddress_Sentinel,
2635 } LDKNetAddress_Tag;
2637 typedef struct LDKNetAddress_LDKIPv4_Body {
2639 * The 4-byte IPv4 address
2641 struct LDKFourBytes addr;
2643 * The port on which the node is listening
2646 } LDKNetAddress_LDKIPv4_Body;
2648 typedef struct LDKNetAddress_LDKIPv6_Body {
2650 * The 16-byte IPv6 address
2652 struct LDKSixteenBytes addr;
2654 * The port on which the node is listening
2657 } LDKNetAddress_LDKIPv6_Body;
2659 typedef struct LDKNetAddress_LDKOnionV2_Body {
2661 * The bytes (usually encoded in base32 with \".onion\" appended)
2663 struct LDKTenBytes addr;
2665 * The port on which the node is listening
2668 } LDKNetAddress_LDKOnionV2_Body;
2670 typedef struct LDKNetAddress_LDKOnionV3_Body {
2672 * The ed25519 long-term public key of the peer
2674 struct LDKThirtyTwoBytes ed25519_pubkey;
2676 * The checksum of the pubkey and version, as included in the onion address
2680 * The version byte, as defined by the Tor Onion v3 spec.
2684 * The port on which the node is listening
2687 } LDKNetAddress_LDKOnionV3_Body;
2689 typedef struct MUST_USE_STRUCT LDKNetAddress {
2690 LDKNetAddress_Tag tag;
2692 LDKNetAddress_LDKIPv4_Body i_pv4;
2693 LDKNetAddress_LDKIPv6_Body i_pv6;
2694 LDKNetAddress_LDKOnionV2_Body onion_v2;
2695 LDKNetAddress_LDKOnionV3_Body onion_v3;
2700 * A dynamically-allocated array of crate::ln::msgs::NetAddresss of arbitrary size.
2701 * This corresponds to std::vector in C++
2703 typedef struct LDKCVec_NetAddressZ {
2705 * The elements in the array.
2706 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
2708 struct LDKNetAddress *data;
2710 * The number of elements pointed to by `data`.
2713 } LDKCVec_NetAddressZ;
2718 * Information received in the latest node_announcement from this node.
2720 typedef struct MUST_USE_STRUCT LDKNodeAnnouncementInfo {
2722 * A pointer to the opaque Rust object.
2723 * Nearly everywhere, inner must be non-null, however in places where
2724 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2726 LDKnativeNodeAnnouncementInfo *inner;
2728 * Indicates that this is the only struct which contains the same pointer.
2729 * Rust functions which take ownership of an object provided via an argument require
2730 * this to be true and invalidate the object pointed to by inner.
2733 } LDKNodeAnnouncementInfo;
2736 * The contents of CResult_NodeAnnouncementInfoDecodeErrorZ
2738 typedef union LDKCResult_NodeAnnouncementInfoDecodeErrorZPtr {
2740 * A pointer to the contents in the success state.
2741 * Reading from this pointer when `result_ok` is not set is undefined.
2743 struct LDKNodeAnnouncementInfo *result;
2745 * A pointer to the contents in the error state.
2746 * Reading from this pointer when `result_ok` is set is undefined.
2748 struct LDKDecodeError *err;
2749 } LDKCResult_NodeAnnouncementInfoDecodeErrorZPtr;
2752 * A CResult_NodeAnnouncementInfoDecodeErrorZ represents the result of a fallible operation,
2753 * containing a crate::routing::network_graph::NodeAnnouncementInfo on success and a crate::ln::msgs::DecodeError on failure.
2754 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
2756 typedef struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ {
2758 * The contents of this CResult_NodeAnnouncementInfoDecodeErrorZ, accessible via either
2759 * `err` or `result` depending on the state of `result_ok`.
2761 union LDKCResult_NodeAnnouncementInfoDecodeErrorZPtr contents;
2763 * Whether this CResult_NodeAnnouncementInfoDecodeErrorZ represents a success state.
2766 } LDKCResult_NodeAnnouncementInfoDecodeErrorZ;
2769 * A dynamically-allocated array of u64s of arbitrary size.
2770 * This corresponds to std::vector in C++
2772 typedef struct LDKCVec_u64Z {
2774 * The elements in the array.
2775 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
2779 * The number of elements pointed to by `data`.
2787 * Details about a node in the network, known from the network announcement.
2789 typedef struct MUST_USE_STRUCT LDKNodeInfo {
2791 * A pointer to the opaque Rust object.
2792 * Nearly everywhere, inner must be non-null, however in places where
2793 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2795 LDKnativeNodeInfo *inner;
2797 * Indicates that this is the only struct which contains the same pointer.
2798 * Rust functions which take ownership of an object provided via an argument require
2799 * this to be true and invalidate the object pointed to by inner.
2805 * The contents of CResult_NodeInfoDecodeErrorZ
2807 typedef union LDKCResult_NodeInfoDecodeErrorZPtr {
2809 * A pointer to the contents in the success state.
2810 * Reading from this pointer when `result_ok` is not set is undefined.
2812 struct LDKNodeInfo *result;
2814 * A pointer to the contents in the error state.
2815 * Reading from this pointer when `result_ok` is set is undefined.
2817 struct LDKDecodeError *err;
2818 } LDKCResult_NodeInfoDecodeErrorZPtr;
2821 * A CResult_NodeInfoDecodeErrorZ represents the result of a fallible operation,
2822 * containing a crate::routing::network_graph::NodeInfo on success and a crate::ln::msgs::DecodeError on failure.
2823 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
2825 typedef struct LDKCResult_NodeInfoDecodeErrorZ {
2827 * The contents of this CResult_NodeInfoDecodeErrorZ, accessible via either
2828 * `err` or `result` depending on the state of `result_ok`.
2830 union LDKCResult_NodeInfoDecodeErrorZPtr contents;
2832 * Whether this CResult_NodeInfoDecodeErrorZ represents a success state.
2835 } LDKCResult_NodeInfoDecodeErrorZ;
2840 * Represents the network as nodes and channels between them
2842 typedef struct MUST_USE_STRUCT LDKNetworkGraph {
2844 * A pointer to the opaque Rust object.
2845 * Nearly everywhere, inner must be non-null, however in places where
2846 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2848 LDKnativeNetworkGraph *inner;
2850 * Indicates that this is the only struct which contains the same pointer.
2851 * Rust functions which take ownership of an object provided via an argument require
2852 * this to be true and invalidate the object pointed to by inner.
2858 * The contents of CResult_NetworkGraphDecodeErrorZ
2860 typedef union LDKCResult_NetworkGraphDecodeErrorZPtr {
2862 * A pointer to the contents in the success state.
2863 * Reading from this pointer when `result_ok` is not set is undefined.
2865 struct LDKNetworkGraph *result;
2867 * A pointer to the contents in the error state.
2868 * Reading from this pointer when `result_ok` is set is undefined.
2870 struct LDKDecodeError *err;
2871 } LDKCResult_NetworkGraphDecodeErrorZPtr;
2874 * A CResult_NetworkGraphDecodeErrorZ represents the result of a fallible operation,
2875 * containing a crate::routing::network_graph::NetworkGraph on success and a crate::ln::msgs::DecodeError on failure.
2876 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
2878 typedef struct LDKCResult_NetworkGraphDecodeErrorZ {
2880 * The contents of this CResult_NetworkGraphDecodeErrorZ, accessible via either
2881 * `err` or `result` depending on the state of `result_ok`.
2883 union LDKCResult_NetworkGraphDecodeErrorZPtr contents;
2885 * Whether this CResult_NetworkGraphDecodeErrorZ represents a success state.
2888 } LDKCResult_NetworkGraphDecodeErrorZ;
2891 * A tuple of 2 elements. See the individual fields for the types contained.
2893 typedef struct LDKC2Tuple_usizeTransactionZ {
2895 * The element at position 0
2899 * The element at position 1
2901 struct LDKTransaction b;
2902 } LDKC2Tuple_usizeTransactionZ;
2905 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_usizeTransactionZs of arbitrary size.
2906 * This corresponds to std::vector in C++
2908 typedef struct LDKCVec_C2Tuple_usizeTransactionZZ {
2910 * The elements in the array.
2911 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
2913 struct LDKC2Tuple_usizeTransactionZ *data;
2915 * The number of elements pointed to by `data`.
2918 } LDKCVec_C2Tuple_usizeTransactionZZ;
2921 * The contents of CResult_NoneChannelMonitorUpdateErrZ
2923 typedef union LDKCResult_NoneChannelMonitorUpdateErrZPtr {
2925 * Note that this value is always NULL, as there are no contents in the OK variant
2929 * A pointer to the contents in the error state.
2930 * Reading from this pointer when `result_ok` is set is undefined.
2932 enum LDKChannelMonitorUpdateErr *err;
2933 } LDKCResult_NoneChannelMonitorUpdateErrZPtr;
2936 * A CResult_NoneChannelMonitorUpdateErrZ represents the result of a fallible operation,
2937 * containing a () on success and a crate::chain::channelmonitor::ChannelMonitorUpdateErr on failure.
2938 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
2940 typedef struct LDKCResult_NoneChannelMonitorUpdateErrZ {
2942 * The contents of this CResult_NoneChannelMonitorUpdateErrZ, accessible via either
2943 * `err` or `result` depending on the state of `result_ok`.
2945 union LDKCResult_NoneChannelMonitorUpdateErrZPtr contents;
2947 * Whether this CResult_NoneChannelMonitorUpdateErrZ represents a success state.
2950 } LDKCResult_NoneChannelMonitorUpdateErrZ;
2955 * Simple structure sent back by `chain::Watch` when an HTLC from a forward channel is detected on
2956 * chain. Used to update the corresponding HTLC in the backward channel. Failing to pass the
2957 * preimage claim backward will lead to loss of funds.
2959 typedef struct MUST_USE_STRUCT LDKHTLCUpdate {
2961 * A pointer to the opaque Rust object.
2962 * Nearly everywhere, inner must be non-null, however in places where
2963 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2965 LDKnativeHTLCUpdate *inner;
2967 * Indicates that this is the only struct which contains the same pointer.
2968 * Rust functions which take ownership of an object provided via an argument require
2969 * this to be true and invalidate the object pointed to by inner.
2977 * A reference to a transaction output.
2979 * Differs from bitcoin::blockdata::transaction::OutPoint as the index is a u16 instead of u32
2980 * due to LN's restrictions on index values. Should reduce (possibly) unsafe conversions this way.
2982 typedef struct MUST_USE_STRUCT LDKOutPoint {
2984 * A pointer to the opaque Rust object.
2985 * Nearly everywhere, inner must be non-null, however in places where
2986 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2988 LDKnativeOutPoint *inner;
2990 * Indicates that this is the only struct which contains the same pointer.
2991 * Rust functions which take ownership of an object provided via an argument require
2992 * this to be true and invalidate the object pointed to by inner.
2998 * An event to be processed by the ChannelManager.
3000 typedef enum LDKMonitorEvent_Tag {
3002 * A monitor event containing an HTLCUpdate.
3004 LDKMonitorEvent_HTLCEvent,
3006 * A monitor event that the Channel's commitment transaction was broadcasted.
3008 LDKMonitorEvent_CommitmentTxBroadcasted,
3010 * Must be last for serialization purposes
3012 LDKMonitorEvent_Sentinel,
3013 } LDKMonitorEvent_Tag;
3015 typedef struct MUST_USE_STRUCT LDKMonitorEvent {
3016 LDKMonitorEvent_Tag tag;
3019 struct LDKHTLCUpdate htlc_event;
3022 struct LDKOutPoint commitment_tx_broadcasted;
3028 * A dynamically-allocated array of crate::chain::channelmonitor::MonitorEvents of arbitrary size.
3029 * This corresponds to std::vector in C++
3031 typedef struct LDKCVec_MonitorEventZ {
3033 * The elements in the array.
3034 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
3036 struct LDKMonitorEvent *data;
3038 * The number of elements pointed to by `data`.
3041 } LDKCVec_MonitorEventZ;
3046 * Information about a spendable output to a P2WSH script. See
3047 * SpendableOutputDescriptor::DelayedPaymentOutput for more details on how to spend this.
3049 typedef struct MUST_USE_STRUCT LDKDelayedPaymentOutputDescriptor {
3051 * A pointer to the opaque Rust object.
3052 * Nearly everywhere, inner must be non-null, however in places where
3053 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3055 LDKnativeDelayedPaymentOutputDescriptor *inner;
3057 * Indicates that this is the only struct which contains the same pointer.
3058 * Rust functions which take ownership of an object provided via an argument require
3059 * this to be true and invalidate the object pointed to by inner.
3062 } LDKDelayedPaymentOutputDescriptor;
3067 * Information about a spendable output to our \"payment key\". See
3068 * SpendableOutputDescriptor::StaticPaymentOutput for more details on how to spend this.
3070 typedef struct MUST_USE_STRUCT LDKStaticPaymentOutputDescriptor {
3072 * A pointer to the opaque Rust object.
3073 * Nearly everywhere, inner must be non-null, however in places where
3074 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3076 LDKnativeStaticPaymentOutputDescriptor *inner;
3078 * Indicates that this is the only struct which contains the same pointer.
3079 * Rust functions which take ownership of an object provided via an argument require
3080 * this to be true and invalidate the object pointed to by inner.
3083 } LDKStaticPaymentOutputDescriptor;
3086 * When on-chain outputs are created by rust-lightning (which our counterparty is not able to
3087 * claim at any point in the future) an event is generated which you must track and be able to
3088 * spend on-chain. The information needed to do this is provided in this enum, including the
3089 * outpoint describing which txid and output index is available, the full output which exists at
3090 * that txid/index, and any keys or other information required to sign.
3092 typedef enum LDKSpendableOutputDescriptor_Tag {
3094 * An output to a script which was provided via KeysInterface directly, either from
3095 * `get_destination_script()` or `get_shutdown_pubkey()`, thus you should already know how to
3096 * spend it. No secret keys are provided as rust-lightning was never given any key.
3097 * These may include outputs from a transaction punishing our counterparty or claiming an HTLC
3098 * on-chain using the payment preimage or after it has timed out.
3100 LDKSpendableOutputDescriptor_StaticOutput,
3102 * An output to a P2WSH script which can be spent with a single signature after a CSV delay.
3104 * The witness in the spending input should be:
3105 * <BIP 143 signature> <empty vector> (MINIMALIF standard rule) <provided witnessScript>
3107 * Note that the nSequence field in the spending input must be set to to_self_delay
3108 * (which means the transaction is not broadcastable until at least to_self_delay
3109 * blocks after the outpoint confirms).
3111 * These are generally the result of a \"revocable\" output to us, spendable only by us unless
3112 * it is an output from an old state which we broadcast (which should never happen).
3114 * To derive the delayed_payment key which is used to sign for this input, you must pass the
3115 * holder delayed_payment_base_key (ie the private key which corresponds to the pubkey in
3116 * Sign::pubkeys().delayed_payment_basepoint) and the provided per_commitment_point to
3117 * chan_utils::derive_private_key. The public key can be generated without the secret key
3118 * using chan_utils::derive_public_key and only the delayed_payment_basepoint which appears in
3121 * To derive the revocation_pubkey provided here (which is used in the witness
3122 * script generation), you must pass the counterparty revocation_basepoint (which appears in the
3123 * call to Sign::ready_channel) and the provided per_commitment point
3124 * to chan_utils::derive_public_revocation_key.
3126 * The witness script which is hashed and included in the output script_pubkey may be
3127 * regenerated by passing the revocation_pubkey (derived as above), our delayed_payment pubkey
3128 * (derived as above), and the to_self_delay contained here to
3129 * chan_utils::get_revokeable_redeemscript.
3131 LDKSpendableOutputDescriptor_DelayedPaymentOutput,
3133 * An output to a P2WPKH, spendable exclusively by our payment key (ie the private key which
3134 * corresponds to the public key in Sign::pubkeys().payment_point).
3135 * The witness in the spending input, is, thus, simply:
3136 * <BIP 143 signature> <payment key>
3138 * These are generally the result of our counterparty having broadcast the current state,
3139 * allowing us to claim the non-HTLC-encumbered outputs immediately.
3141 LDKSpendableOutputDescriptor_StaticPaymentOutput,
3143 * Must be last for serialization purposes
3145 LDKSpendableOutputDescriptor_Sentinel,
3146 } LDKSpendableOutputDescriptor_Tag;
3148 typedef struct LDKSpendableOutputDescriptor_LDKStaticOutput_Body {
3150 * The outpoint which is spendable
3152 struct LDKOutPoint outpoint;
3154 * The output which is referenced by the given outpoint.
3156 struct LDKTxOut output;
3157 } LDKSpendableOutputDescriptor_LDKStaticOutput_Body;
3159 typedef struct MUST_USE_STRUCT LDKSpendableOutputDescriptor {
3160 LDKSpendableOutputDescriptor_Tag tag;
3162 LDKSpendableOutputDescriptor_LDKStaticOutput_Body static_output;
3164 struct LDKDelayedPaymentOutputDescriptor delayed_payment_output;
3167 struct LDKStaticPaymentOutputDescriptor static_payment_output;
3170 } LDKSpendableOutputDescriptor;
3173 * A dynamically-allocated array of crate::chain::keysinterface::SpendableOutputDescriptors of arbitrary size.
3174 * This corresponds to std::vector in C++
3176 typedef struct LDKCVec_SpendableOutputDescriptorZ {
3178 * The elements in the array.
3179 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
3181 struct LDKSpendableOutputDescriptor *data;
3183 * The number of elements pointed to by `data`.
3186 } LDKCVec_SpendableOutputDescriptorZ;
3189 * An Event which you should probably take some action in response to.
3191 * Note that while Writeable and Readable are implemented for Event, you probably shouldn't use
3192 * them directly as they don't round-trip exactly (for example FundingGenerationReady is never
3193 * written as it makes no sense to respond to it after reconnecting to peers).
3195 typedef enum LDKEvent_Tag {
3197 * Used to indicate that the client should generate a funding transaction with the given
3198 * parameters and then call ChannelManager::funding_transaction_generated.
3199 * Generated in ChannelManager message handling.
3200 * Note that *all inputs* in the funding transaction must spend SegWit outputs or your
3201 * counterparty can steal your funds!
3203 LDKEvent_FundingGenerationReady,
3205 * Used to indicate that the client may now broadcast the funding transaction it created for a
3206 * channel. Broadcasting such a transaction prior to this event may lead to our counterparty
3207 * trivially stealing all funds in the funding transaction!
3209 LDKEvent_FundingBroadcastSafe,
3211 * Indicates we've received money! Just gotta dig out that payment preimage and feed it to
3212 * ChannelManager::claim_funds to get it....
3213 * Note that if the preimage is not known or the amount paid is incorrect, you should call
3214 * ChannelManager::fail_htlc_backwards to free up resources for this HTLC and avoid
3215 * network congestion.
3216 * The amount paid should be considered 'incorrect' when it is less than or more than twice
3217 * the amount expected.
3218 * If you fail to call either ChannelManager::claim_funds or
3219 * ChannelManager::fail_htlc_backwards within the HTLC's timeout, the HTLC will be
3220 * automatically failed.
3222 LDKEvent_PaymentReceived,
3224 * Indicates an outbound payment we made succeeded (ie it made it all the way to its target
3225 * and we got back the payment preimage for it).
3226 * Note that duplicative PaymentSent Events may be generated - it is your responsibility to
3227 * deduplicate them by payment_preimage (which MUST be unique)!
3229 LDKEvent_PaymentSent,
3231 * Indicates an outbound payment we made failed. Probably some intermediary node dropped
3232 * something. You may wish to retry with a different route.
3233 * Note that duplicative PaymentFailed Events may be generated - it is your responsibility to
3234 * deduplicate them by payment_hash (which MUST be unique)!
3236 LDKEvent_PaymentFailed,
3238 * Used to indicate that ChannelManager::process_pending_htlc_forwards should be called at a
3239 * time in the future.
3241 LDKEvent_PendingHTLCsForwardable,
3243 * Used to indicate that an output was generated on-chain which you should know how to spend.
3244 * Such an output will *not* ever be spent by rust-lightning, and are not at risk of your
3245 * counterparty spending them due to some kind of timeout. Thus, you need to store them
3246 * somewhere and spend them when you create on-chain transactions.
3248 LDKEvent_SpendableOutputs,
3250 * Must be last for serialization purposes
3255 typedef struct LDKEvent_LDKFundingGenerationReady_Body {
3257 * The random channel_id we picked which you'll need to pass into
3258 * ChannelManager::funding_transaction_generated.
3260 struct LDKThirtyTwoBytes temporary_channel_id;
3262 * The value, in satoshis, that the output should have.
3264 uint64_t channel_value_satoshis;
3266 * The script which should be used in the transaction output.
3268 struct LDKCVec_u8Z output_script;
3270 * The value passed in to ChannelManager::create_channel
3272 uint64_t user_channel_id;
3273 } LDKEvent_LDKFundingGenerationReady_Body;
3275 typedef struct LDKEvent_LDKFundingBroadcastSafe_Body {
3277 * The output, which was passed to ChannelManager::funding_transaction_generated, which is
3278 * now safe to broadcast.
3280 struct LDKOutPoint funding_txo;
3282 * The value passed in to ChannelManager::create_channel
3284 uint64_t user_channel_id;
3285 } LDKEvent_LDKFundingBroadcastSafe_Body;
3287 typedef struct LDKEvent_LDKPaymentReceived_Body {
3289 * The hash for which the preimage should be handed to the ChannelManager.
3291 struct LDKThirtyTwoBytes payment_hash;
3293 * The \"payment secret\". This authenticates the sender to the recipient, preventing a
3294 * number of deanonymization attacks during the routing process.
3295 * As nodes upgrade, the invoices you provide should likely migrate to setting the
3296 * payment_secret feature to required, at which point you should fail_backwards any HTLCs
3297 * which have a None here.
3298 * Until then, however, values of None should be ignored, and only incorrect Some values
3299 * should result in an HTLC fail_backwards.
3300 * Note that, in any case, this value must be passed as-is to any fail or claim calls as
3301 * the HTLC index includes this value.
3303 struct LDKThirtyTwoBytes payment_secret;
3305 * The value, in thousandths of a satoshi, that this payment is for. Note that you must
3306 * compare this to the expected value before accepting the payment (as otherwise you are
3307 * providing proof-of-payment for less than the value you expected!).
3310 } LDKEvent_LDKPaymentReceived_Body;
3312 typedef struct LDKEvent_LDKPaymentSent_Body {
3314 * The preimage to the hash given to ChannelManager::send_payment.
3315 * Note that this serves as a payment receipt, if you wish to have such a thing, you must
3318 struct LDKThirtyTwoBytes payment_preimage;
3319 } LDKEvent_LDKPaymentSent_Body;
3321 typedef struct LDKEvent_LDKPaymentFailed_Body {
3323 * The hash which was given to ChannelManager::send_payment.
3325 struct LDKThirtyTwoBytes payment_hash;
3327 * Indicates the payment was rejected for some reason by the recipient. This implies that
3328 * the payment has failed, not just the route in question. If this is not set, you may
3329 * retry the payment via a different route.
3331 bool rejected_by_dest;
3332 } LDKEvent_LDKPaymentFailed_Body;
3334 typedef struct LDKEvent_LDKPendingHTLCsForwardable_Body {
3336 * The minimum amount of time that should be waited prior to calling
3337 * process_pending_htlc_forwards. To increase the effort required to correlate payments,
3338 * you should wait a random amount of time in roughly the range (now + time_forwardable,
3339 * now + 5*time_forwardable).
3341 uint64_t time_forwardable;
3342 } LDKEvent_LDKPendingHTLCsForwardable_Body;
3344 typedef struct LDKEvent_LDKSpendableOutputs_Body {
3346 * The outputs which you should store as spendable by you.
3348 struct LDKCVec_SpendableOutputDescriptorZ outputs;
3349 } LDKEvent_LDKSpendableOutputs_Body;
3351 typedef struct MUST_USE_STRUCT LDKEvent {
3354 LDKEvent_LDKFundingGenerationReady_Body funding_generation_ready;
3355 LDKEvent_LDKFundingBroadcastSafe_Body funding_broadcast_safe;
3356 LDKEvent_LDKPaymentReceived_Body payment_received;
3357 LDKEvent_LDKPaymentSent_Body payment_sent;
3358 LDKEvent_LDKPaymentFailed_Body payment_failed;
3359 LDKEvent_LDKPendingHTLCsForwardable_Body pending_htl_cs_forwardable;
3360 LDKEvent_LDKSpendableOutputs_Body spendable_outputs;
3365 * A dynamically-allocated array of crate::util::events::Events of arbitrary size.
3366 * This corresponds to std::vector in C++
3368 typedef struct LDKCVec_EventZ {
3370 * The elements in the array.
3371 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
3373 struct LDKEvent *data;
3375 * The number of elements pointed to by `data`.
3381 * The contents of CResult_OutPointDecodeErrorZ
3383 typedef union LDKCResult_OutPointDecodeErrorZPtr {
3385 * A pointer to the contents in the success state.
3386 * Reading from this pointer when `result_ok` is not set is undefined.
3388 struct LDKOutPoint *result;
3390 * A pointer to the contents in the error state.
3391 * Reading from this pointer when `result_ok` is set is undefined.
3393 struct LDKDecodeError *err;
3394 } LDKCResult_OutPointDecodeErrorZPtr;
3397 * A CResult_OutPointDecodeErrorZ represents the result of a fallible operation,
3398 * containing a crate::chain::transaction::OutPoint on success and a crate::ln::msgs::DecodeError on failure.
3399 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3401 typedef struct LDKCResult_OutPointDecodeErrorZ {
3403 * The contents of this CResult_OutPointDecodeErrorZ, accessible via either
3404 * `err` or `result` depending on the state of `result_ok`.
3406 union LDKCResult_OutPointDecodeErrorZPtr contents;
3408 * Whether this CResult_OutPointDecodeErrorZ represents a success state.
3411 } LDKCResult_OutPointDecodeErrorZ;
3416 * An update generated by the underlying Channel itself which contains some new information the
3417 * ChannelMonitor should be made aware of.
3419 typedef struct MUST_USE_STRUCT LDKChannelMonitorUpdate {
3421 * A pointer to the opaque Rust object.
3422 * Nearly everywhere, inner must be non-null, however in places where
3423 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3425 LDKnativeChannelMonitorUpdate *inner;
3427 * Indicates that this is the only struct which contains the same pointer.
3428 * Rust functions which take ownership of an object provided via an argument require
3429 * this to be true and invalidate the object pointed to by inner.
3432 } LDKChannelMonitorUpdate;
3435 * The contents of CResult_ChannelMonitorUpdateDecodeErrorZ
3437 typedef union LDKCResult_ChannelMonitorUpdateDecodeErrorZPtr {
3439 * A pointer to the contents in the success state.
3440 * Reading from this pointer when `result_ok` is not set is undefined.
3442 struct LDKChannelMonitorUpdate *result;
3444 * A pointer to the contents in the error state.
3445 * Reading from this pointer when `result_ok` is set is undefined.
3447 struct LDKDecodeError *err;
3448 } LDKCResult_ChannelMonitorUpdateDecodeErrorZPtr;
3451 * A CResult_ChannelMonitorUpdateDecodeErrorZ represents the result of a fallible operation,
3452 * containing a crate::chain::channelmonitor::ChannelMonitorUpdate on success and a crate::ln::msgs::DecodeError on failure.
3453 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3455 typedef struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ {
3457 * The contents of this CResult_ChannelMonitorUpdateDecodeErrorZ, accessible via either
3458 * `err` or `result` depending on the state of `result_ok`.
3460 union LDKCResult_ChannelMonitorUpdateDecodeErrorZPtr contents;
3462 * Whether this CResult_ChannelMonitorUpdateDecodeErrorZ represents a success state.
3465 } LDKCResult_ChannelMonitorUpdateDecodeErrorZ;
3468 * The contents of CResult_HTLCUpdateDecodeErrorZ
3470 typedef union LDKCResult_HTLCUpdateDecodeErrorZPtr {
3472 * A pointer to the contents in the success state.
3473 * Reading from this pointer when `result_ok` is not set is undefined.
3475 struct LDKHTLCUpdate *result;
3477 * A pointer to the contents in the error state.
3478 * Reading from this pointer when `result_ok` is set is undefined.
3480 struct LDKDecodeError *err;
3481 } LDKCResult_HTLCUpdateDecodeErrorZPtr;
3484 * A CResult_HTLCUpdateDecodeErrorZ represents the result of a fallible operation,
3485 * containing a crate::chain::channelmonitor::HTLCUpdate on success and a crate::ln::msgs::DecodeError on failure.
3486 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3488 typedef struct LDKCResult_HTLCUpdateDecodeErrorZ {
3490 * The contents of this CResult_HTLCUpdateDecodeErrorZ, accessible via either
3491 * `err` or `result` depending on the state of `result_ok`.
3493 union LDKCResult_HTLCUpdateDecodeErrorZPtr contents;
3495 * Whether this CResult_HTLCUpdateDecodeErrorZ represents a success state.
3498 } LDKCResult_HTLCUpdateDecodeErrorZ;
3503 * General Err type for ChannelMonitor actions. Generally, this implies that the data provided is
3504 * inconsistent with the ChannelMonitor being called. eg for ChannelMonitor::update_monitor this
3505 * means you tried to update a monitor for a different channel or the ChannelMonitorUpdate was
3507 * Contains a developer-readable error message.
3509 typedef struct MUST_USE_STRUCT LDKMonitorUpdateError {
3511 * A pointer to the opaque Rust object.
3512 * Nearly everywhere, inner must be non-null, however in places where
3513 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3515 LDKnativeMonitorUpdateError *inner;
3517 * Indicates that this is the only struct which contains the same pointer.
3518 * Rust functions which take ownership of an object provided via an argument require
3519 * this to be true and invalidate the object pointed to by inner.
3522 } LDKMonitorUpdateError;
3525 * The contents of CResult_NoneMonitorUpdateErrorZ
3527 typedef union LDKCResult_NoneMonitorUpdateErrorZPtr {
3529 * Note that this value is always NULL, as there are no contents in the OK variant
3533 * A pointer to the contents in the error state.
3534 * Reading from this pointer when `result_ok` is set is undefined.
3536 struct LDKMonitorUpdateError *err;
3537 } LDKCResult_NoneMonitorUpdateErrorZPtr;
3540 * A CResult_NoneMonitorUpdateErrorZ represents the result of a fallible operation,
3541 * containing a () on success and a crate::chain::channelmonitor::MonitorUpdateError on failure.
3542 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3544 typedef struct LDKCResult_NoneMonitorUpdateErrorZ {
3546 * The contents of this CResult_NoneMonitorUpdateErrorZ, accessible via either
3547 * `err` or `result` depending on the state of `result_ok`.
3549 union LDKCResult_NoneMonitorUpdateErrorZPtr contents;
3551 * Whether this CResult_NoneMonitorUpdateErrorZ represents a success state.
3554 } LDKCResult_NoneMonitorUpdateErrorZ;
3557 * A tuple of 2 elements. See the individual fields for the types contained.
3559 typedef struct LDKC2Tuple_OutPointScriptZ {
3561 * The element at position 0
3563 struct LDKOutPoint a;
3565 * The element at position 1
3567 struct LDKCVec_u8Z b;
3568 } LDKC2Tuple_OutPointScriptZ;
3571 * A tuple of 2 elements. See the individual fields for the types contained.
3573 typedef struct LDKC2Tuple_u32ScriptZ {
3575 * The element at position 0
3579 * The element at position 1
3581 struct LDKCVec_u8Z b;
3582 } LDKC2Tuple_u32ScriptZ;
3585 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_u32ScriptZs of arbitrary size.
3586 * This corresponds to std::vector in C++
3588 typedef struct LDKCVec_C2Tuple_u32ScriptZZ {
3590 * The elements in the array.
3591 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
3593 struct LDKC2Tuple_u32ScriptZ *data;
3595 * The number of elements pointed to by `data`.
3598 } LDKCVec_C2Tuple_u32ScriptZZ;
3601 * A tuple of 2 elements. See the individual fields for the types contained.
3603 typedef struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ {
3605 * The element at position 0
3607 struct LDKThirtyTwoBytes a;
3609 * The element at position 1
3611 struct LDKCVec_C2Tuple_u32ScriptZZ b;
3612 } LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ;
3615 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZs of arbitrary size.
3616 * This corresponds to std::vector in C++
3618 typedef struct LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ {
3620 * The elements in the array.
3621 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
3623 struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ *data;
3625 * The number of elements pointed to by `data`.
3628 } LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ;
3631 * A dynamically-allocated array of crate::c_types::Transactions of arbitrary size.
3632 * This corresponds to std::vector in C++
3634 typedef struct LDKCVec_TransactionZ {
3636 * The elements in the array.
3637 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
3639 struct LDKTransaction *data;
3641 * The number of elements pointed to by `data`.
3644 } LDKCVec_TransactionZ;
3647 * A tuple of 2 elements. See the individual fields for the types contained.
3649 typedef struct LDKC2Tuple_u32TxOutZ {
3651 * The element at position 0
3655 * The element at position 1
3658 } LDKC2Tuple_u32TxOutZ;
3661 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_u32TxOutZs of arbitrary size.
3662 * This corresponds to std::vector in C++
3664 typedef struct LDKCVec_C2Tuple_u32TxOutZZ {
3666 * The elements in the array.
3667 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
3669 struct LDKC2Tuple_u32TxOutZ *data;
3671 * The number of elements pointed to by `data`.
3674 } LDKCVec_C2Tuple_u32TxOutZZ;
3677 * A tuple of 2 elements. See the individual fields for the types contained.
3679 typedef struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ {
3681 * The element at position 0
3683 struct LDKThirtyTwoBytes a;
3685 * The element at position 1
3687 struct LDKCVec_C2Tuple_u32TxOutZZ b;
3688 } LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ;
3691 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZs of arbitrary size.
3692 * This corresponds to std::vector in C++
3694 typedef struct LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZZ {
3696 * The elements in the array.
3697 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
3699 struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ *data;
3701 * The number of elements pointed to by `data`.
3704 } LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZZ;
3707 * A tuple of 2 elements. See the individual fields for the types contained.
3709 typedef struct LDKC2Tuple_SignatureCVec_SignatureZZ {
3711 * The element at position 0
3713 struct LDKSignature a;
3715 * The element at position 1
3717 struct LDKCVec_SignatureZ b;
3718 } LDKC2Tuple_SignatureCVec_SignatureZZ;
3721 * The contents of CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ
3723 typedef union LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZPtr {
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 LDKC2Tuple_SignatureCVec_SignatureZZ *result;
3730 * Note that this value is always NULL, as there are no contents in the Err variant
3733 } LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZPtr;
3736 * A CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ represents the result of a fallible operation,
3737 * containing a crate::c_types::derived::C2Tuple_SignatureCVec_SignatureZZ on success and a () on failure.
3738 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3740 typedef struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ {
3742 * The contents of this CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ, accessible via either
3743 * `err` or `result` depending on the state of `result_ok`.
3745 union LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZPtr contents;
3747 * Whether this CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ represents a success state.
3750 } LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ;
3753 * The contents of CResult_SignatureNoneZ
3755 typedef union LDKCResult_SignatureNoneZPtr {
3757 * A pointer to the contents in the success state.
3758 * Reading from this pointer when `result_ok` is not set is undefined.
3760 struct LDKSignature *result;
3762 * Note that this value is always NULL, as there are no contents in the Err variant
3765 } LDKCResult_SignatureNoneZPtr;
3768 * A CResult_SignatureNoneZ represents the result of a fallible operation,
3769 * containing a crate::c_types::Signature on success and a () on failure.
3770 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3772 typedef struct LDKCResult_SignatureNoneZ {
3774 * The contents of this CResult_SignatureNoneZ, accessible via either
3775 * `err` or `result` depending on the state of `result_ok`.
3777 union LDKCResult_SignatureNoneZPtr contents;
3779 * Whether this CResult_SignatureNoneZ represents a success state.
3782 } LDKCResult_SignatureNoneZ;
3787 * The unsigned part of a channel_announcement
3789 typedef struct MUST_USE_STRUCT LDKUnsignedChannelAnnouncement {
3791 * A pointer to the opaque Rust object.
3792 * Nearly everywhere, inner must be non-null, however in places where
3793 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3795 LDKnativeUnsignedChannelAnnouncement *inner;
3797 * Indicates that this is the only struct which contains the same pointer.
3798 * Rust functions which take ownership of an object provided via an argument require
3799 * this to be true and invalidate the object pointed to by inner.
3802 } LDKUnsignedChannelAnnouncement;
3805 * A trait to sign lightning channel transactions as described in BOLT 3.
3807 * Signing services could be implemented on a hardware wallet. In this case,
3808 * the current Sign would be a front-end on top of a communication
3809 * channel connected to your secure device and lightning key material wouldn't
3810 * reside on a hot server. Nevertheless, a this deployment would still need
3811 * to trust the ChannelManager to avoid loss of funds as this latest component
3812 * could ask to sign commitment transaction with HTLCs paying to attacker pubkeys.
3814 * A more secure iteration would be to use hashlock (or payment points) to pair
3815 * invoice/incoming HTLCs with outgoing HTLCs to implement a no-trust-ChannelManager
3816 * at the price of more state and computation on the hardware wallet side. In the future,
3817 * we are looking forward to design such interface.
3819 * In any case, ChannelMonitor or fallback watchtowers are always going to be trusted
3820 * to act, as liveness and breach reply correctness are always going to be hard requirements
3821 * of LN security model, orthogonal of key management issues.
3823 typedef struct LDKSign {
3825 * An opaque pointer which is passed to your function implementations as an argument.
3826 * This has no meaning in the LDK, and can be NULL or any other value.
3830 * Gets the per-commitment point for a specific commitment number
3832 * Note that the commitment number starts at (1 << 48) - 1 and counts backwards.
3834 struct LDKPublicKey (*get_per_commitment_point)(const void *this_arg, uint64_t idx);
3836 * Gets the commitment secret for a specific commitment number as part of the revocation process
3838 * An external signer implementation should error here if the commitment was already signed
3839 * and should refuse to sign it in the future.
3841 * May be called more than once for the same index.
3843 * Note that the commitment number starts at (1 << 48) - 1 and counts backwards.
3845 struct LDKThirtyTwoBytes (*release_commitment_secret)(const void *this_arg, uint64_t idx);
3847 * Gets the holder's channel public keys and basepoints
3849 struct LDKChannelPublicKeys pubkeys;
3851 * Fill in the pubkeys field as a reference to it will be given to Rust after this returns
3852 * Note that this takes a pointer to this object, not the this_ptr like other methods do
3853 * This function pointer may be NULL if pubkeys is filled in when this object is created and never needs updating.
3855 void (*set_pubkeys)(const struct LDKSign*NONNULL_PTR );
3857 * Gets an arbitrary identifier describing the set of keys which are provided back to you in
3858 * some SpendableOutputDescriptor types. This should be sufficient to identify this
3859 * Sign object uniquely and lookup or re-derive its keys.
3861 struct LDKThirtyTwoBytes (*channel_keys_id)(const void *this_arg);
3863 * Create a signature for a counterparty's commitment transaction and associated HTLC transactions.
3865 * Note that if signing fails or is rejected, the channel will be force-closed.
3867 struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ (*sign_counterparty_commitment)(const void *this_arg, const struct LDKCommitmentTransaction *NONNULL_PTR commitment_tx);
3869 * Create a signatures for a holder's commitment transaction and its claiming HTLC transactions.
3870 * This will only ever be called with a non-revoked commitment_tx. This will be called with the
3871 * latest commitment_tx when we initiate a force-close.
3872 * This will be called with the previous latest, just to get claiming HTLC signatures, if we are
3873 * reacting to a ChannelMonitor replica that decided to broadcast before it had been updated to
3875 * This may be called multiple times for the same transaction.
3877 * An external signer implementation should check that the commitment has not been revoked.
3879 * May return Err if key derivation fails. Callers, such as ChannelMonitor, will panic in such a case.
3881 struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ (*sign_holder_commitment_and_htlcs)(const void *this_arg, const struct LDKHolderCommitmentTransaction *NONNULL_PTR commitment_tx);
3883 * Create a signature for the given input in a transaction spending an HTLC or commitment
3884 * transaction output when our counterparty broadcasts an old state.
3886 * A justice transaction may claim multiples outputs at the same time if timelocks are
3887 * similar, but only a signature for the input at index `input` should be signed for here.
3888 * It may be called multiples time for same output(s) if a fee-bump is needed with regards
3889 * to an upcoming timelock expiration.
3891 * Amount is value of the output spent by this input, committed to in the BIP 143 signature.
3893 * per_commitment_key is revocation secret which was provided by our counterparty when they
3894 * revoked the state which they eventually broadcast. It's not a _holder_ secret key and does
3895 * not allow the spending of any funds by itself (you need our holder revocation_secret to do
3898 * htlc holds HTLC elements (hash, timelock) if the output being spent is a HTLC output, thus
3899 * changing the format of the witness script (which is committed to in the BIP 143
3902 struct LDKCResult_SignatureNoneZ (*sign_justice_transaction)(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);
3904 * Create a signature for a claiming transaction for a HTLC output on a counterparty's commitment
3905 * transaction, either offered or received.
3907 * Such a transaction may claim multiples offered outputs at same time if we know the
3908 * preimage for each when we create it, but only the input at index `input` should be
3909 * signed for here. It may be called multiple times for same output(s) if a fee-bump is
3910 * needed with regards to an upcoming timelock expiration.
3912 * Witness_script is either a offered or received script as defined in BOLT3 for HTLC
3915 * Amount is value of the output spent by this input, committed to in the BIP 143 signature.
3917 * Per_commitment_point is the dynamic point corresponding to the channel state
3918 * detected onchain. It has been generated by our counterparty and is used to derive
3919 * channel state keys, which are then included in the witness script and committed to in the
3920 * BIP 143 signature.
3922 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);
3924 * Create a signature for a (proposed) closing transaction.
3926 * Note that, due to rounding, there may be one \"missing\" satoshi, and either party may have
3927 * chosen to forgo their output as dust.
3929 struct LDKCResult_SignatureNoneZ (*sign_closing_transaction)(const void *this_arg, struct LDKTransaction closing_tx);
3931 * Signs a channel announcement message with our funding key, proving it comes from one
3932 * of the channel participants.
3934 * Note that if this fails or is rejected, the channel will not be publicly announced and
3935 * our counterparty may (though likely will not) close the channel on us for violating the
3938 struct LDKCResult_SignatureNoneZ (*sign_channel_announcement)(const void *this_arg, const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR msg);
3940 * Set the counterparty static channel data, including basepoints,
3941 * counterparty_selected/holder_selected_contest_delay and funding outpoint.
3942 * This is done as soon as the funding outpoint is known. Since these are static channel data,
3943 * they MUST NOT be allowed to change to different values once set.
3945 * channel_parameters.is_populated() MUST be true.
3947 * We bind holder_selected_contest_delay late here for API convenience.
3949 * Will be called before any signatures are applied.
3951 void (*ready_channel)(void *this_arg, const struct LDKChannelTransactionParameters *NONNULL_PTR channel_parameters);
3953 * Creates a copy of the object pointed to by this_arg, for a copy of this Sign.
3954 * Note that the ultimate copy of the Sign will have all function pointers the same as the original.
3955 * May be NULL if no action needs to be taken, the this_arg pointer will be copied into the new Sign.
3957 void *(*clone)(const void *this_arg);
3959 * Serialize the object into a byte array
3961 struct LDKCVec_u8Z (*write)(const void *this_arg);
3963 * Frees any resources associated with this object given its this_arg pointer.
3964 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
3966 void (*free)(void *this_arg);
3972 * A ChannelMonitor handles chain events (blocks connected and disconnected) and generates
3973 * on-chain transactions to ensure no loss of funds occurs.
3975 * You MUST ensure that no ChannelMonitors for a given channel anywhere contain out-of-date
3976 * information and are actively monitoring the chain.
3978 * Pending Events or updated HTLCs which have not yet been read out by
3979 * get_and_clear_pending_monitor_events or get_and_clear_pending_events are serialized to disk and
3980 * reloaded at deserialize-time. Thus, you must ensure that, when handling events, all events
3981 * gotten are fully handled before re-serializing the new state.
3983 * Note that the deserializer is only implemented for (BlockHash, ChannelMonitor), which
3984 * tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
3985 * the \"reorg path\" (ie disconnecting blocks until you find a common ancestor from both the
3986 * returned block hash and the the current chain and then reconnecting blocks to get to the
3987 * best chain) upon deserializing the object!
3989 typedef struct MUST_USE_STRUCT LDKChannelMonitor {
3991 * A pointer to the opaque Rust object.
3992 * Nearly everywhere, inner must be non-null, however in places where
3993 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3995 LDKnativeChannelMonitor *inner;
3997 * Indicates that this is the only struct which contains the same pointer.
3998 * Rust functions which take ownership of an object provided via an argument require
3999 * this to be true and invalidate the object pointed to by inner.
4002 } LDKChannelMonitor;
4005 * A tuple of 2 elements. See the individual fields for the types contained.
4007 typedef struct LDKC2Tuple_BlockHashChannelMonitorZ {
4009 * The element at position 0
4011 struct LDKThirtyTwoBytes a;
4013 * The element at position 1
4015 struct LDKChannelMonitor b;
4016 } LDKC2Tuple_BlockHashChannelMonitorZ;
4019 * The contents of CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ
4021 typedef union LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZPtr {
4023 * A pointer to the contents in the success state.
4024 * Reading from this pointer when `result_ok` is not set is undefined.
4026 struct LDKC2Tuple_BlockHashChannelMonitorZ *result;
4028 * A pointer to the contents in the error state.
4029 * Reading from this pointer when `result_ok` is set is undefined.
4031 struct LDKDecodeError *err;
4032 } LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZPtr;
4035 * A CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ represents the result of a fallible operation,
4036 * containing a crate::c_types::derived::C2Tuple_BlockHashChannelMonitorZ on success and a crate::ln::msgs::DecodeError on failure.
4037 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4039 typedef struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ {
4041 * The contents of this CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ, accessible via either
4042 * `err` or `result` depending on the state of `result_ok`.
4044 union LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZPtr contents;
4046 * Whether this CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ represents a success state.
4049 } LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ;
4052 * The contents of CResult_TxOutAccessErrorZ
4054 typedef union LDKCResult_TxOutAccessErrorZPtr {
4056 * A pointer to the contents in the success state.
4057 * Reading from this pointer when `result_ok` is not set is undefined.
4059 struct LDKTxOut *result;
4061 * A pointer to the contents in the error state.
4062 * Reading from this pointer when `result_ok` is set is undefined.
4064 enum LDKAccessError *err;
4065 } LDKCResult_TxOutAccessErrorZPtr;
4068 * A CResult_TxOutAccessErrorZ represents the result of a fallible operation,
4069 * containing a crate::c_types::TxOut on success and a crate::chain::AccessError on failure.
4070 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4072 typedef struct LDKCResult_TxOutAccessErrorZ {
4074 * The contents of this CResult_TxOutAccessErrorZ, accessible via either
4075 * `err` or `result` depending on the state of `result_ok`.
4077 union LDKCResult_TxOutAccessErrorZPtr contents;
4079 * Whether this CResult_TxOutAccessErrorZ represents a success state.
4082 } LDKCResult_TxOutAccessErrorZ;
4085 * An enum which can either contain a crate::c_types::derived::C2Tuple_usizeTransactionZ or not
4087 typedef enum LDKCOption_C2Tuple_usizeTransactionZZ_Tag {
4089 * When we're in this state, this COption_C2Tuple_usizeTransactionZZ contains a crate::c_types::derived::C2Tuple_usizeTransactionZ
4091 LDKCOption_C2Tuple_usizeTransactionZZ_Some,
4093 * When we're in this state, this COption_C2Tuple_usizeTransactionZZ contains nothing
4095 LDKCOption_C2Tuple_usizeTransactionZZ_None,
4097 * Must be last for serialization purposes
4099 LDKCOption_C2Tuple_usizeTransactionZZ_Sentinel,
4100 } LDKCOption_C2Tuple_usizeTransactionZZ_Tag;
4102 typedef struct LDKCOption_C2Tuple_usizeTransactionZZ {
4103 LDKCOption_C2Tuple_usizeTransactionZZ_Tag tag;
4106 struct LDKC2Tuple_usizeTransactionZ some;
4109 } LDKCOption_C2Tuple_usizeTransactionZZ;
4112 * A Rust str object, ie a reference to a UTF8-valid string.
4113 * This is *not* null-terminated so cannot be used directly as a C string!
4115 typedef struct LDKStr {
4117 * A pointer to the string's bytes, in UTF8 encoding
4119 const uint8_t *chars;
4121 * The number of bytes (not characters!) pointed to by `chars`
4127 * Indicates an error on the client's part (usually some variant of attempting to use too-low or
4130 typedef enum LDKAPIError_Tag {
4132 * Indicates the API was wholly misused (see err for more). Cases where these can be returned
4133 * are documented, but generally indicates some precondition of a function was violated.
4135 LDKAPIError_APIMisuseError,
4137 * Due to a high feerate, we were unable to complete the request.
4138 * For example, this may be returned if the feerate implies we cannot open a channel at the
4139 * requested value, but opening a larger channel would succeed.
4141 LDKAPIError_FeeRateTooHigh,
4143 * A malformed Route was provided (eg overflowed value, node id mismatch, overly-looped route,
4144 * too-many-hops, etc).
4146 LDKAPIError_RouteError,
4148 * We were unable to complete the request as the Channel required to do so is unable to
4149 * complete the request (or was not found). This can take many forms, including disconnected
4150 * peer, channel at capacity, channel shutting down, etc.
4152 LDKAPIError_ChannelUnavailable,
4154 * An attempt to call watch/update_channel returned an Err (ie you did this!), causing the
4155 * attempted action to fail.
4157 LDKAPIError_MonitorUpdateFailed,
4159 * Must be last for serialization purposes
4161 LDKAPIError_Sentinel,
4164 typedef struct LDKAPIError_LDKAPIMisuseError_Body {
4166 * A human-readable error message
4168 struct LDKCVec_u8Z err;
4169 } LDKAPIError_LDKAPIMisuseError_Body;
4171 typedef struct LDKAPIError_LDKFeeRateTooHigh_Body {
4173 * A human-readable error message
4175 struct LDKCVec_u8Z err;
4177 * The feerate which was too high.
4180 } LDKAPIError_LDKFeeRateTooHigh_Body;
4182 typedef struct LDKAPIError_LDKRouteError_Body {
4184 * A human-readable error message
4187 } LDKAPIError_LDKRouteError_Body;
4189 typedef struct LDKAPIError_LDKChannelUnavailable_Body {
4191 * A human-readable error message
4193 struct LDKCVec_u8Z err;
4194 } LDKAPIError_LDKChannelUnavailable_Body;
4196 typedef struct MUST_USE_STRUCT LDKAPIError {
4197 LDKAPIError_Tag tag;
4199 LDKAPIError_LDKAPIMisuseError_Body api_misuse_error;
4200 LDKAPIError_LDKFeeRateTooHigh_Body fee_rate_too_high;
4201 LDKAPIError_LDKRouteError_Body route_error;
4202 LDKAPIError_LDKChannelUnavailable_Body channel_unavailable;
4207 * The contents of CResult_NoneAPIErrorZ
4209 typedef union LDKCResult_NoneAPIErrorZPtr {
4211 * Note that this value is always NULL, as there are no contents in the OK variant
4215 * A pointer to the contents in the error state.
4216 * Reading from this pointer when `result_ok` is set is undefined.
4218 struct LDKAPIError *err;
4219 } LDKCResult_NoneAPIErrorZPtr;
4222 * A CResult_NoneAPIErrorZ represents the result of a fallible operation,
4223 * containing a () on success and a crate::util::errors::APIError on failure.
4224 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4226 typedef struct LDKCResult_NoneAPIErrorZ {
4228 * The contents of this CResult_NoneAPIErrorZ, accessible via either
4229 * `err` or `result` depending on the state of `result_ok`.
4231 union LDKCResult_NoneAPIErrorZPtr contents;
4233 * Whether this CResult_NoneAPIErrorZ represents a success state.
4236 } LDKCResult_NoneAPIErrorZ;
4239 * A dynamically-allocated array of crate::c_types::derived::CResult_NoneAPIErrorZs of arbitrary size.
4240 * This corresponds to std::vector in C++
4242 typedef struct LDKCVec_CResult_NoneAPIErrorZZ {
4244 * The elements in the array.
4245 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
4247 struct LDKCResult_NoneAPIErrorZ *data;
4249 * The number of elements pointed to by `data`.
4252 } LDKCVec_CResult_NoneAPIErrorZZ;
4255 * A dynamically-allocated array of crate::util::errors::APIErrors of arbitrary size.
4256 * This corresponds to std::vector in C++
4258 typedef struct LDKCVec_APIErrorZ {
4260 * The elements in the array.
4261 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
4263 struct LDKAPIError *data;
4265 * The number of elements pointed to by `data`.
4268 } LDKCVec_APIErrorZ;
4273 * Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
4275 typedef struct MUST_USE_STRUCT LDKChannelDetails {
4277 * A pointer to the opaque Rust object.
4278 * Nearly everywhere, inner must be non-null, however in places where
4279 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4281 LDKnativeChannelDetails *inner;
4283 * Indicates that this is the only struct which contains the same pointer.
4284 * Rust functions which take ownership of an object provided via an argument require
4285 * this to be true and invalidate the object pointed to by inner.
4288 } LDKChannelDetails;
4291 * A dynamically-allocated array of crate::ln::channelmanager::ChannelDetailss of arbitrary size.
4292 * This corresponds to std::vector in C++
4294 typedef struct LDKCVec_ChannelDetailsZ {
4296 * The elements in the array.
4297 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
4299 struct LDKChannelDetails *data;
4301 * The number of elements pointed to by `data`.
4304 } LDKCVec_ChannelDetailsZ;
4307 * If a payment fails to send, it can be in one of several states. This enum is returned as the
4308 * Err() type describing which state the payment is in, see the description of individual enum
4311 typedef enum LDKPaymentSendFailure_Tag {
4313 * A parameter which was passed to send_payment was invalid, preventing us from attempting to
4314 * send the payment at all. No channel state has been changed or messages sent to peers, and
4315 * once you've changed the parameter at error, you can freely retry the payment in full.
4317 LDKPaymentSendFailure_ParameterError,
4319 * A parameter in a single path which was passed to send_payment was invalid, preventing us
4320 * from attempting to send the payment at all. No channel state has been changed or messages
4321 * sent to peers, and once you've changed the parameter at error, you can freely retry the
4324 * The results here are ordered the same as the paths in the route object which was passed to
4327 LDKPaymentSendFailure_PathParameterError,
4329 * All paths which were attempted failed to send, with no channel state change taking place.
4330 * You can freely retry the payment in full (though you probably want to do so over different
4331 * paths than the ones selected).
4333 LDKPaymentSendFailure_AllFailedRetrySafe,
4335 * Some paths which were attempted failed to send, though possibly not all. At least some
4336 * paths have irrevocably committed to the HTLC and retrying the payment in full would result
4337 * in over-/re-payment.
4339 * The results here are ordered the same as the paths in the route object which was passed to
4340 * send_payment, and any Errs which are not APIError::MonitorUpdateFailed can be safely
4341 * retried (though there is currently no API with which to do so).
4343 * Any entries which contain Err(APIError::MonitorUpdateFailed) or Ok(()) MUST NOT be retried
4344 * as they will result in over-/re-payment. These HTLCs all either successfully sent (in the
4345 * case of Ok(())) or will send once channel_monitor_updated is called on the next-hop channel
4346 * with the latest update_id.
4348 LDKPaymentSendFailure_PartialFailure,
4350 * Must be last for serialization purposes
4352 LDKPaymentSendFailure_Sentinel,
4353 } LDKPaymentSendFailure_Tag;
4355 typedef struct MUST_USE_STRUCT LDKPaymentSendFailure {
4356 LDKPaymentSendFailure_Tag tag;
4359 struct LDKAPIError parameter_error;
4362 struct LDKCVec_CResult_NoneAPIErrorZZ path_parameter_error;
4365 struct LDKCVec_APIErrorZ all_failed_retry_safe;
4368 struct LDKCVec_CResult_NoneAPIErrorZZ partial_failure;
4371 } LDKPaymentSendFailure;
4374 * The contents of CResult_NonePaymentSendFailureZ
4376 typedef union LDKCResult_NonePaymentSendFailureZPtr {
4378 * Note that this value is always NULL, as there are no contents in the OK variant
4382 * A pointer to the contents in the error state.
4383 * Reading from this pointer when `result_ok` is set is undefined.
4385 struct LDKPaymentSendFailure *err;
4386 } LDKCResult_NonePaymentSendFailureZPtr;
4389 * A CResult_NonePaymentSendFailureZ represents the result of a fallible operation,
4390 * containing a () on success and a crate::ln::channelmanager::PaymentSendFailure on failure.
4391 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4393 typedef struct LDKCResult_NonePaymentSendFailureZ {
4395 * The contents of this CResult_NonePaymentSendFailureZ, accessible via either
4396 * `err` or `result` depending on the state of `result_ok`.
4398 union LDKCResult_NonePaymentSendFailureZPtr contents;
4400 * Whether this CResult_NonePaymentSendFailureZ represents a success state.
4403 } LDKCResult_NonePaymentSendFailureZ;
4406 * A dynamically-allocated array of crate::chain::channelmonitor::ChannelMonitors of arbitrary size.
4407 * This corresponds to std::vector in C++
4409 typedef struct LDKCVec_ChannelMonitorZ {
4411 * The elements in the array.
4412 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
4414 struct LDKChannelMonitor *data;
4416 * The number of elements pointed to by `data`.
4419 } LDKCVec_ChannelMonitorZ;
4422 * The `Watch` trait defines behavior for watching on-chain activity pertaining to channels as
4423 * blocks are connected and disconnected.
4425 * Each channel is associated with a [`ChannelMonitor`]. Implementations of this trait are
4426 * responsible for maintaining a set of monitors such that they can be updated accordingly as
4427 * channel state changes and HTLCs are resolved. See method documentation for specific
4430 * Implementations **must** ensure that updates are successfully applied and persisted upon method
4431 * completion. If an update fails with a [`PermanentFailure`], then it must immediately shut down
4432 * without taking any further action such as persisting the current state.
4434 * If an implementation maintains multiple instances of a channel's monitor (e.g., by storing
4435 * backup copies), then it must ensure that updates are applied across all instances. Otherwise, it
4436 * could result in a revoked transaction being broadcast, allowing the counterparty to claim all
4437 * funds in the channel. See [`ChannelMonitorUpdateErr`] for more details about how to handle
4438 * multiple instances.
4440 * [`ChannelMonitor`]: channelmonitor::ChannelMonitor
4441 * [`ChannelMonitorUpdateErr`]: channelmonitor::ChannelMonitorUpdateErr
4442 * [`PermanentFailure`]: channelmonitor::ChannelMonitorUpdateErr::PermanentFailure
4444 typedef struct LDKWatch {
4446 * An opaque pointer which is passed to your function implementations as an argument.
4447 * This has no meaning in the LDK, and can be NULL or any other value.
4451 * Watches a channel identified by `funding_txo` using `monitor`.
4453 * Implementations are responsible for watching the chain for the funding transaction along
4454 * with any spends of outputs returned by [`get_outputs_to_watch`]. In practice, this means
4455 * calling [`block_connected`] and [`block_disconnected`] on the monitor.
4457 * [`get_outputs_to_watch`]: channelmonitor::ChannelMonitor::get_outputs_to_watch
4458 * [`block_connected`]: channelmonitor::ChannelMonitor::block_connected
4459 * [`block_disconnected`]: channelmonitor::ChannelMonitor::block_disconnected
4461 struct LDKCResult_NoneChannelMonitorUpdateErrZ (*watch_channel)(const void *this_arg, struct LDKOutPoint funding_txo, struct LDKChannelMonitor monitor);
4463 * Updates a channel identified by `funding_txo` by applying `update` to its monitor.
4465 * Implementations must call [`update_monitor`] with the given update. See
4466 * [`ChannelMonitorUpdateErr`] for invariants around returning an error.
4468 * [`update_monitor`]: channelmonitor::ChannelMonitor::update_monitor
4469 * [`ChannelMonitorUpdateErr`]: channelmonitor::ChannelMonitorUpdateErr
4471 struct LDKCResult_NoneChannelMonitorUpdateErrZ (*update_channel)(const void *this_arg, struct LDKOutPoint funding_txo, struct LDKChannelMonitorUpdate update);
4473 * Returns any monitor events since the last call. Subsequent calls must only return new
4476 struct LDKCVec_MonitorEventZ (*release_pending_monitor_events)(const void *this_arg);
4478 * Frees any resources associated with this object given its this_arg pointer.
4479 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
4481 void (*free)(void *this_arg);
4485 * An interface to send a transaction to the Bitcoin network.
4487 typedef struct LDKBroadcasterInterface {
4489 * An opaque pointer which is passed to your function implementations as an argument.
4490 * This has no meaning in the LDK, and can be NULL or any other value.
4494 * Sends a transaction out to (hopefully) be mined.
4496 void (*broadcast_transaction)(const void *this_arg, struct LDKTransaction tx);
4498 * Frees any resources associated with this object given its this_arg pointer.
4499 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
4501 void (*free)(void *this_arg);
4502 } LDKBroadcasterInterface;
4505 * The contents of CResult_SignDecodeErrorZ
4507 typedef union LDKCResult_SignDecodeErrorZPtr {
4509 * A pointer to the contents in the success state.
4510 * Reading from this pointer when `result_ok` is not set is undefined.
4512 struct LDKSign *result;
4514 * A pointer to the contents in the error state.
4515 * Reading from this pointer when `result_ok` is set is undefined.
4517 struct LDKDecodeError *err;
4518 } LDKCResult_SignDecodeErrorZPtr;
4521 * A CResult_SignDecodeErrorZ represents the result of a fallible operation,
4522 * containing a crate::chain::keysinterface::Sign on success and a crate::ln::msgs::DecodeError on failure.
4523 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4525 typedef struct LDKCResult_SignDecodeErrorZ {
4527 * The contents of this CResult_SignDecodeErrorZ, accessible via either
4528 * `err` or `result` depending on the state of `result_ok`.
4530 union LDKCResult_SignDecodeErrorZPtr contents;
4532 * Whether this CResult_SignDecodeErrorZ represents a success state.
4535 } LDKCResult_SignDecodeErrorZ;
4538 * A "slice" referencing some byte array. This is simply a length-tagged pointer which does not
4539 * own the memory pointed to by data.
4541 typedef struct LDKu8slice {
4543 * A pointer to the byte buffer
4545 const uint8_t *data;
4547 * The number of bytes pointed to by `data`.
4553 * A trait to describe an object which can get user secrets and key material.
4555 typedef struct LDKKeysInterface {
4557 * An opaque pointer which is passed to your function implementations as an argument.
4558 * This has no meaning in the LDK, and can be NULL or any other value.
4562 * Get node secret key (aka node_id or network_key).
4564 * This method must return the same value each time it is called.
4566 struct LDKSecretKey (*get_node_secret)(const void *this_arg);
4568 * Get a script pubkey which we send funds to when claiming on-chain contestable outputs.
4570 * This method should return a different value each time it is called, to avoid linking
4571 * on-chain funds across channels as controlled to the same user.
4573 struct LDKCVec_u8Z (*get_destination_script)(const void *this_arg);
4575 * Get a public key which we will send funds to (in the form of a P2WPKH output) when closing
4578 * This method should return a different value each time it is called, to avoid linking
4579 * on-chain funds across channels as controlled to the same user.
4581 struct LDKPublicKey (*get_shutdown_pubkey)(const void *this_arg);
4583 * Get a new set of Sign for per-channel secrets. These MUST be unique even if you
4584 * restarted with some stale data!
4586 * This method must return a different value each time it is called.
4588 struct LDKSign (*get_channel_signer)(const void *this_arg, bool inbound, uint64_t channel_value_satoshis);
4590 * Gets a unique, cryptographically-secure, random 32 byte value. This is used for encrypting
4591 * onion packets and for temporary channel IDs. There is no requirement that these be
4592 * persisted anywhere, though they must be unique across restarts.
4594 * This method must return a different value each time it is called.
4596 struct LDKThirtyTwoBytes (*get_secure_random_bytes)(const void *this_arg);
4598 * Reads a `Signer` for this `KeysInterface` from the given input stream.
4599 * This is only called during deserialization of other objects which contain
4600 * `Sign`-implementing objects (ie `ChannelMonitor`s and `ChannelManager`s).
4601 * The bytes are exactly those which `<Self::Signer as Writeable>::write()` writes, and
4602 * contain no versioning scheme. You may wish to include your own version prefix and ensure
4603 * you've read all of the provided bytes to ensure no corruption occurred.
4605 struct LDKCResult_SignDecodeErrorZ (*read_chan_signer)(const void *this_arg, struct LDKu8slice reader);
4607 * Frees any resources associated with this object given its this_arg pointer.
4608 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
4610 void (*free)(void *this_arg);
4614 * A trait which should be implemented to provide feerate information on a number of time
4617 * Note that all of the functions implemented here *must* be reentrant-safe (obviously - they're
4618 * called from inside the library in response to chain events, P2P events, or timer events).
4620 typedef struct LDKFeeEstimator {
4622 * An opaque pointer which is passed to your function implementations as an argument.
4623 * This has no meaning in the LDK, and can be NULL or any other value.
4627 * Gets estimated satoshis of fee required per 1000 Weight-Units.
4629 * Must be no smaller than 253 (ie 1 satoshi-per-byte rounded up to ensure later round-downs
4630 * don't put us below 1 satoshi-per-byte).
4632 * This translates to:
4633 * * satoshis-per-byte * 250
4634 * * ceil(satoshis-per-kbyte / 4)
4636 uint32_t (*get_est_sat_per_1000_weight)(const void *this_arg, enum LDKConfirmationTarget confirmation_target);
4638 * Frees any resources associated with this object given its this_arg pointer.
4639 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
4641 void (*free)(void *this_arg);
4645 * A trait encapsulating the operations required of a logger
4647 typedef struct LDKLogger {
4649 * An opaque pointer which is passed to your function implementations as an argument.
4650 * This has no meaning in the LDK, and can be NULL or any other value.
4656 void (*log)(const void *this_arg, const char *record);
4658 * Frees any resources associated with this object given its this_arg pointer.
4659 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
4661 void (*free)(void *this_arg);
4667 * Manager which keeps track of a number of channels and sends messages to the appropriate
4668 * channel, also tracking HTLC preimages and forwarding onion packets appropriately.
4670 * Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
4671 * to individual Channels.
4673 * Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
4674 * all peers during write/read (though does not modify this instance, only the instance being
4675 * serialized). This will result in any channels which have not yet exchanged funding_created (ie
4676 * called funding_transaction_generated for outbound channels).
4678 * Note that you can be a bit lazier about writing out ChannelManager than you can be with
4679 * ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
4680 * returning from chain::Watch::watch_/update_channel, with ChannelManagers, writing updates
4681 * happens out-of-band (and will prevent any other ChannelManager operations from occurring during
4682 * the serialization process). If the deserialized version is out-of-date compared to the
4683 * ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
4684 * ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
4686 * Note that the deserializer is only implemented for (BlockHash, ChannelManager), which
4687 * tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
4688 * the \"reorg path\" (ie call block_disconnected() until you get to a common block and then call
4689 * block_connected() to step towards your best block) upon deserialization before using the
4692 * Note that ChannelManager is responsible for tracking liveness of its channels and generating
4693 * ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
4694 * spam due to quick disconnection/reconnection, updates are not sent until the channel has been
4695 * offline for a full minute. In order to track this, you must call
4696 * timer_chan_freshness_every_min roughly once per minute, though it doesn't have to be perfect.
4698 * Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
4699 * a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
4700 * essentially you should default to using a SimpleRefChannelManager, and use a
4701 * SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
4702 * you're using lightning-net-tokio.
4704 typedef struct MUST_USE_STRUCT LDKChannelManager {
4706 * A pointer to the opaque Rust object.
4707 * Nearly everywhere, inner must be non-null, however in places where
4708 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4710 LDKnativeChannelManager *inner;
4712 * Indicates that this is the only struct which contains the same pointer.
4713 * Rust functions which take ownership of an object provided via an argument require
4714 * this to be true and invalidate the object pointed to by inner.
4717 } LDKChannelManager;
4720 * A tuple of 2 elements. See the individual fields for the types contained.
4722 typedef struct LDKC2Tuple_BlockHashChannelManagerZ {
4724 * The element at position 0
4726 struct LDKThirtyTwoBytes a;
4728 * The element at position 1
4730 struct LDKChannelManager b;
4731 } LDKC2Tuple_BlockHashChannelManagerZ;
4734 * The contents of CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ
4736 typedef union LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZPtr {
4738 * A pointer to the contents in the success state.
4739 * Reading from this pointer when `result_ok` is not set is undefined.
4741 struct LDKC2Tuple_BlockHashChannelManagerZ *result;
4743 * A pointer to the contents in the error state.
4744 * Reading from this pointer when `result_ok` is set is undefined.
4746 struct LDKDecodeError *err;
4747 } LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZPtr;
4750 * A CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ represents the result of a fallible operation,
4751 * containing a crate::c_types::derived::C2Tuple_BlockHashChannelManagerZ on success and a crate::ln::msgs::DecodeError on failure.
4752 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4754 typedef struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ {
4756 * The contents of this CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ, accessible via either
4757 * `err` or `result` depending on the state of `result_ok`.
4759 union LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZPtr contents;
4761 * Whether this CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ represents a success state.
4764 } LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ;
4767 * The contents of CResult_SpendableOutputDescriptorDecodeErrorZ
4769 typedef union LDKCResult_SpendableOutputDescriptorDecodeErrorZPtr {
4771 * A pointer to the contents in the success state.
4772 * Reading from this pointer when `result_ok` is not set is undefined.
4774 struct LDKSpendableOutputDescriptor *result;
4776 * A pointer to the contents in the error state.
4777 * Reading from this pointer when `result_ok` is set is undefined.
4779 struct LDKDecodeError *err;
4780 } LDKCResult_SpendableOutputDescriptorDecodeErrorZPtr;
4783 * A CResult_SpendableOutputDescriptorDecodeErrorZ represents the result of a fallible operation,
4784 * containing a crate::chain::keysinterface::SpendableOutputDescriptor on success and a crate::ln::msgs::DecodeError on failure.
4785 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4787 typedef struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ {
4789 * The contents of this CResult_SpendableOutputDescriptorDecodeErrorZ, accessible via either
4790 * `err` or `result` depending on the state of `result_ok`.
4792 union LDKCResult_SpendableOutputDescriptorDecodeErrorZPtr contents;
4794 * Whether this CResult_SpendableOutputDescriptorDecodeErrorZ represents a success state.
4797 } LDKCResult_SpendableOutputDescriptorDecodeErrorZ;
4800 * A dynamically-allocated array of crate::c_types::derived::CVec_u8Zs of arbitrary size.
4801 * This corresponds to std::vector in C++
4803 typedef struct LDKCVec_CVec_u8ZZ {
4805 * The elements in the array.
4806 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
4808 struct LDKCVec_u8Z *data;
4810 * The number of elements pointed to by `data`.
4813 } LDKCVec_CVec_u8ZZ;
4816 * The contents of CResult_CVec_CVec_u8ZZNoneZ
4818 typedef union LDKCResult_CVec_CVec_u8ZZNoneZPtr {
4820 * A pointer to the contents in the success state.
4821 * Reading from this pointer when `result_ok` is not set is undefined.
4823 struct LDKCVec_CVec_u8ZZ *result;
4825 * Note that this value is always NULL, as there are no contents in the Err variant
4828 } LDKCResult_CVec_CVec_u8ZZNoneZPtr;
4831 * A CResult_CVec_CVec_u8ZZNoneZ represents the result of a fallible operation,
4832 * containing a crate::c_types::derived::CVec_CVec_u8ZZ on success and a () on failure.
4833 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4835 typedef struct LDKCResult_CVec_CVec_u8ZZNoneZ {
4837 * The contents of this CResult_CVec_CVec_u8ZZNoneZ, accessible via either
4838 * `err` or `result` depending on the state of `result_ok`.
4840 union LDKCResult_CVec_CVec_u8ZZNoneZPtr contents;
4842 * Whether this CResult_CVec_CVec_u8ZZNoneZ represents a success state.
4845 } LDKCResult_CVec_CVec_u8ZZNoneZ;
4850 * A simple implementation of Sign that just keeps the private keys in memory.
4852 * This implementation performs no policy checks and is insufficient by itself as
4853 * a secure external signer.
4855 typedef struct MUST_USE_STRUCT LDKInMemorySigner {
4857 * A pointer to the opaque Rust object.
4858 * Nearly everywhere, inner must be non-null, however in places where
4859 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4861 LDKnativeInMemorySigner *inner;
4863 * Indicates that this is the only struct which contains the same pointer.
4864 * Rust functions which take ownership of an object provided via an argument require
4865 * this to be true and invalidate the object pointed to by inner.
4868 } LDKInMemorySigner;
4871 * The contents of CResult_InMemorySignerDecodeErrorZ
4873 typedef union LDKCResult_InMemorySignerDecodeErrorZPtr {
4875 * A pointer to the contents in the success state.
4876 * Reading from this pointer when `result_ok` is not set is undefined.
4878 struct LDKInMemorySigner *result;
4880 * A pointer to the contents in the error state.
4881 * Reading from this pointer when `result_ok` is set is undefined.
4883 struct LDKDecodeError *err;
4884 } LDKCResult_InMemorySignerDecodeErrorZPtr;
4887 * A CResult_InMemorySignerDecodeErrorZ represents the result of a fallible operation,
4888 * containing a crate::chain::keysinterface::InMemorySigner on success and a crate::ln::msgs::DecodeError on failure.
4889 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4891 typedef struct LDKCResult_InMemorySignerDecodeErrorZ {
4893 * The contents of this CResult_InMemorySignerDecodeErrorZ, accessible via either
4894 * `err` or `result` depending on the state of `result_ok`.
4896 union LDKCResult_InMemorySignerDecodeErrorZPtr contents;
4898 * Whether this CResult_InMemorySignerDecodeErrorZ represents a success state.
4901 } LDKCResult_InMemorySignerDecodeErrorZ;
4904 * A dynamically-allocated array of crate::c_types::TxOuts of arbitrary size.
4905 * This corresponds to std::vector in C++
4907 typedef struct LDKCVec_TxOutZ {
4909 * The elements in the array.
4910 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
4912 struct LDKTxOut *data;
4914 * The number of elements pointed to by `data`.
4920 * The contents of CResult_TransactionNoneZ
4922 typedef union LDKCResult_TransactionNoneZPtr {
4924 * A pointer to the contents in the success state.
4925 * Reading from this pointer when `result_ok` is not set is undefined.
4927 struct LDKTransaction *result;
4929 * Note that this value is always NULL, as there are no contents in the Err variant
4932 } LDKCResult_TransactionNoneZPtr;
4935 * A CResult_TransactionNoneZ represents the result of a fallible operation,
4936 * containing a crate::c_types::Transaction on success and a () on failure.
4937 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4939 typedef struct LDKCResult_TransactionNoneZ {
4941 * The contents of this CResult_TransactionNoneZ, accessible via either
4942 * `err` or `result` depending on the state of `result_ok`.
4944 union LDKCResult_TransactionNoneZPtr contents;
4946 * Whether this CResult_TransactionNoneZ represents a success state.
4949 } LDKCResult_TransactionNoneZ;
4956 typedef struct MUST_USE_STRUCT LDKRouteHop {
4958 * A pointer to the opaque Rust object.
4959 * Nearly everywhere, inner must be non-null, however in places where
4960 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4962 LDKnativeRouteHop *inner;
4964 * Indicates that this is the only struct which contains the same pointer.
4965 * Rust functions which take ownership of an object provided via an argument require
4966 * this to be true and invalidate the object pointed to by inner.
4972 * A dynamically-allocated array of crate::routing::router::RouteHops of arbitrary size.
4973 * This corresponds to std::vector in C++
4975 typedef struct LDKCVec_RouteHopZ {
4977 * The elements in the array.
4978 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
4980 struct LDKRouteHop *data;
4982 * The number of elements pointed to by `data`.
4985 } LDKCVec_RouteHopZ;
4988 * A dynamically-allocated array of crate::c_types::derived::CVec_RouteHopZs of arbitrary size.
4989 * This corresponds to std::vector in C++
4991 typedef struct LDKCVec_CVec_RouteHopZZ {
4993 * The elements in the array.
4994 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
4996 struct LDKCVec_RouteHopZ *data;
4998 * The number of elements pointed to by `data`.
5001 } LDKCVec_CVec_RouteHopZZ;
5006 * A route directs a payment from the sender (us) to the recipient. If the recipient supports MPP,
5007 * it can take multiple paths. Each path is composed of one or more hops through the network.
5009 typedef struct MUST_USE_STRUCT LDKRoute {
5011 * A pointer to the opaque Rust object.
5012 * Nearly everywhere, inner must be non-null, however in places where
5013 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5015 LDKnativeRoute *inner;
5017 * Indicates that this is the only struct which contains the same pointer.
5018 * Rust functions which take ownership of an object provided via an argument require
5019 * this to be true and invalidate the object pointed to by inner.
5025 * The contents of CResult_RouteDecodeErrorZ
5027 typedef union LDKCResult_RouteDecodeErrorZPtr {
5029 * A pointer to the contents in the success state.
5030 * Reading from this pointer when `result_ok` is not set is undefined.
5032 struct LDKRoute *result;
5034 * A pointer to the contents in the error state.
5035 * Reading from this pointer when `result_ok` is set is undefined.
5037 struct LDKDecodeError *err;
5038 } LDKCResult_RouteDecodeErrorZPtr;
5041 * A CResult_RouteDecodeErrorZ represents the result of a fallible operation,
5042 * containing a crate::routing::router::Route on success and a crate::ln::msgs::DecodeError on failure.
5043 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5045 typedef struct LDKCResult_RouteDecodeErrorZ {
5047 * The contents of this CResult_RouteDecodeErrorZ, accessible via either
5048 * `err` or `result` depending on the state of `result_ok`.
5050 union LDKCResult_RouteDecodeErrorZPtr contents;
5052 * Whether this CResult_RouteDecodeErrorZ represents a success state.
5055 } LDKCResult_RouteDecodeErrorZ;
5060 * A channel descriptor which provides a last-hop route to get_route
5062 typedef struct MUST_USE_STRUCT LDKRouteHint {
5064 * A pointer to the opaque Rust object.
5065 * Nearly everywhere, inner must be non-null, however in places where
5066 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5068 LDKnativeRouteHint *inner;
5070 * Indicates that this is the only struct which contains the same pointer.
5071 * Rust functions which take ownership of an object provided via an argument require
5072 * this to be true and invalidate the object pointed to by inner.
5078 * A dynamically-allocated array of crate::routing::router::RouteHints of arbitrary size.
5079 * This corresponds to std::vector in C++
5081 typedef struct LDKCVec_RouteHintZ {
5083 * The elements in the array.
5084 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
5086 struct LDKRouteHint *data;
5088 * The number of elements pointed to by `data`.
5091 } LDKCVec_RouteHintZ;
5094 * The contents of CResult_RouteLightningErrorZ
5096 typedef union LDKCResult_RouteLightningErrorZPtr {
5098 * A pointer to the contents in the success state.
5099 * Reading from this pointer when `result_ok` is not set is undefined.
5101 struct LDKRoute *result;
5103 * A pointer to the contents in the error state.
5104 * Reading from this pointer when `result_ok` is set is undefined.
5106 struct LDKLightningError *err;
5107 } LDKCResult_RouteLightningErrorZPtr;
5110 * A CResult_RouteLightningErrorZ represents the result of a fallible operation,
5111 * containing a crate::routing::router::Route on success and a crate::ln::msgs::LightningError on failure.
5112 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5114 typedef struct LDKCResult_RouteLightningErrorZ {
5116 * The contents of this CResult_RouteLightningErrorZ, accessible via either
5117 * `err` or `result` depending on the state of `result_ok`.
5119 union LDKCResult_RouteLightningErrorZPtr contents;
5121 * Whether this CResult_RouteLightningErrorZ represents a success state.
5124 } LDKCResult_RouteLightningErrorZ;
5127 * The contents of CResult_NetAddressu8Z
5129 typedef union LDKCResult_NetAddressu8ZPtr {
5131 * A pointer to the contents in the success state.
5132 * Reading from this pointer when `result_ok` is not set is undefined.
5134 struct LDKNetAddress *result;
5136 * A pointer to the contents in the error state.
5137 * Reading from this pointer when `result_ok` is set is undefined.
5140 } LDKCResult_NetAddressu8ZPtr;
5143 * A CResult_NetAddressu8Z represents the result of a fallible operation,
5144 * containing a crate::ln::msgs::NetAddress on success and a u8 on failure.
5145 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5147 typedef struct LDKCResult_NetAddressu8Z {
5149 * The contents of this CResult_NetAddressu8Z, accessible via either
5150 * `err` or `result` depending on the state of `result_ok`.
5152 union LDKCResult_NetAddressu8ZPtr contents;
5154 * Whether this CResult_NetAddressu8Z represents a success state.
5157 } LDKCResult_NetAddressu8Z;
5160 * The contents of CResult_CResult_NetAddressu8ZDecodeErrorZ
5162 typedef union LDKCResult_CResult_NetAddressu8ZDecodeErrorZPtr {
5164 * A pointer to the contents in the success state.
5165 * Reading from this pointer when `result_ok` is not set is undefined.
5167 struct LDKCResult_NetAddressu8Z *result;
5169 * A pointer to the contents in the error state.
5170 * Reading from this pointer when `result_ok` is set is undefined.
5172 struct LDKDecodeError *err;
5173 } LDKCResult_CResult_NetAddressu8ZDecodeErrorZPtr;
5176 * A CResult_CResult_NetAddressu8ZDecodeErrorZ represents the result of a fallible operation,
5177 * containing a crate::c_types::derived::CResult_NetAddressu8Z on success and a crate::ln::msgs::DecodeError on failure.
5178 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5180 typedef struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ {
5182 * The contents of this CResult_CResult_NetAddressu8ZDecodeErrorZ, accessible via either
5183 * `err` or `result` depending on the state of `result_ok`.
5185 union LDKCResult_CResult_NetAddressu8ZDecodeErrorZPtr contents;
5187 * Whether this CResult_CResult_NetAddressu8ZDecodeErrorZ represents a success state.
5190 } LDKCResult_CResult_NetAddressu8ZDecodeErrorZ;
5195 * An update_add_htlc message to be sent or received from a peer
5197 typedef struct MUST_USE_STRUCT LDKUpdateAddHTLC {
5199 * A pointer to the opaque Rust object.
5200 * Nearly everywhere, inner must be non-null, however in places where
5201 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5203 LDKnativeUpdateAddHTLC *inner;
5205 * Indicates that this is the only struct which contains the same pointer.
5206 * Rust functions which take ownership of an object provided via an argument require
5207 * this to be true and invalidate the object pointed to by inner.
5213 * A dynamically-allocated array of crate::ln::msgs::UpdateAddHTLCs of arbitrary size.
5214 * This corresponds to std::vector in C++
5216 typedef struct LDKCVec_UpdateAddHTLCZ {
5218 * The elements in the array.
5219 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
5221 struct LDKUpdateAddHTLC *data;
5223 * The number of elements pointed to by `data`.
5226 } LDKCVec_UpdateAddHTLCZ;
5231 * An update_fulfill_htlc message to be sent or received from a peer
5233 typedef struct MUST_USE_STRUCT LDKUpdateFulfillHTLC {
5235 * A pointer to the opaque Rust object.
5236 * Nearly everywhere, inner must be non-null, however in places where
5237 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5239 LDKnativeUpdateFulfillHTLC *inner;
5241 * Indicates that this is the only struct which contains the same pointer.
5242 * Rust functions which take ownership of an object provided via an argument require
5243 * this to be true and invalidate the object pointed to by inner.
5246 } LDKUpdateFulfillHTLC;
5249 * A dynamically-allocated array of crate::ln::msgs::UpdateFulfillHTLCs of arbitrary size.
5250 * This corresponds to std::vector in C++
5252 typedef struct LDKCVec_UpdateFulfillHTLCZ {
5254 * The elements in the array.
5255 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
5257 struct LDKUpdateFulfillHTLC *data;
5259 * The number of elements pointed to by `data`.
5262 } LDKCVec_UpdateFulfillHTLCZ;
5267 * An update_fail_htlc message to be sent or received from a peer
5269 typedef struct MUST_USE_STRUCT LDKUpdateFailHTLC {
5271 * A pointer to the opaque Rust object.
5272 * Nearly everywhere, inner must be non-null, however in places where
5273 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5275 LDKnativeUpdateFailHTLC *inner;
5277 * Indicates that this is the only struct which contains the same pointer.
5278 * Rust functions which take ownership of an object provided via an argument require
5279 * this to be true and invalidate the object pointed to by inner.
5282 } LDKUpdateFailHTLC;
5285 * A dynamically-allocated array of crate::ln::msgs::UpdateFailHTLCs of arbitrary size.
5286 * This corresponds to std::vector in C++
5288 typedef struct LDKCVec_UpdateFailHTLCZ {
5290 * The elements in the array.
5291 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
5293 struct LDKUpdateFailHTLC *data;
5295 * The number of elements pointed to by `data`.
5298 } LDKCVec_UpdateFailHTLCZ;
5303 * An update_fail_malformed_htlc message to be sent or received from a peer
5305 typedef struct MUST_USE_STRUCT LDKUpdateFailMalformedHTLC {
5307 * A pointer to the opaque Rust object.
5308 * Nearly everywhere, inner must be non-null, however in places where
5309 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5311 LDKnativeUpdateFailMalformedHTLC *inner;
5313 * Indicates that this is the only struct which contains the same pointer.
5314 * Rust functions which take ownership of an object provided via an argument require
5315 * this to be true and invalidate the object pointed to by inner.
5318 } LDKUpdateFailMalformedHTLC;
5321 * A dynamically-allocated array of crate::ln::msgs::UpdateFailMalformedHTLCs of arbitrary size.
5322 * This corresponds to std::vector in C++
5324 typedef struct LDKCVec_UpdateFailMalformedHTLCZ {
5326 * The elements in the array.
5327 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
5329 struct LDKUpdateFailMalformedHTLC *data;
5331 * The number of elements pointed to by `data`.
5334 } LDKCVec_UpdateFailMalformedHTLCZ;
5337 * The contents of CResult_AcceptChannelDecodeErrorZ
5339 typedef union LDKCResult_AcceptChannelDecodeErrorZPtr {
5341 * A pointer to the contents in the success state.
5342 * Reading from this pointer when `result_ok` is not set is undefined.
5344 struct LDKAcceptChannel *result;
5346 * A pointer to the contents in the error state.
5347 * Reading from this pointer when `result_ok` is set is undefined.
5349 struct LDKDecodeError *err;
5350 } LDKCResult_AcceptChannelDecodeErrorZPtr;
5353 * A CResult_AcceptChannelDecodeErrorZ represents the result of a fallible operation,
5354 * containing a crate::ln::msgs::AcceptChannel on success and a crate::ln::msgs::DecodeError on failure.
5355 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5357 typedef struct LDKCResult_AcceptChannelDecodeErrorZ {
5359 * The contents of this CResult_AcceptChannelDecodeErrorZ, accessible via either
5360 * `err` or `result` depending on the state of `result_ok`.
5362 union LDKCResult_AcceptChannelDecodeErrorZPtr contents;
5364 * Whether this CResult_AcceptChannelDecodeErrorZ represents a success state.
5367 } LDKCResult_AcceptChannelDecodeErrorZ;
5370 * The contents of CResult_AnnouncementSignaturesDecodeErrorZ
5372 typedef union LDKCResult_AnnouncementSignaturesDecodeErrorZPtr {
5374 * A pointer to the contents in the success state.
5375 * Reading from this pointer when `result_ok` is not set is undefined.
5377 struct LDKAnnouncementSignatures *result;
5379 * A pointer to the contents in the error state.
5380 * Reading from this pointer when `result_ok` is set is undefined.
5382 struct LDKDecodeError *err;
5383 } LDKCResult_AnnouncementSignaturesDecodeErrorZPtr;
5386 * A CResult_AnnouncementSignaturesDecodeErrorZ represents the result of a fallible operation,
5387 * containing a crate::ln::msgs::AnnouncementSignatures on success and a crate::ln::msgs::DecodeError on failure.
5388 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5390 typedef struct LDKCResult_AnnouncementSignaturesDecodeErrorZ {
5392 * The contents of this CResult_AnnouncementSignaturesDecodeErrorZ, accessible via either
5393 * `err` or `result` depending on the state of `result_ok`.
5395 union LDKCResult_AnnouncementSignaturesDecodeErrorZPtr contents;
5397 * Whether this CResult_AnnouncementSignaturesDecodeErrorZ represents a success state.
5400 } LDKCResult_AnnouncementSignaturesDecodeErrorZ;
5403 * The contents of CResult_ChannelReestablishDecodeErrorZ
5405 typedef union LDKCResult_ChannelReestablishDecodeErrorZPtr {
5407 * A pointer to the contents in the success state.
5408 * Reading from this pointer when `result_ok` is not set is undefined.
5410 struct LDKChannelReestablish *result;
5412 * A pointer to the contents in the error state.
5413 * Reading from this pointer when `result_ok` is set is undefined.
5415 struct LDKDecodeError *err;
5416 } LDKCResult_ChannelReestablishDecodeErrorZPtr;
5419 * A CResult_ChannelReestablishDecodeErrorZ represents the result of a fallible operation,
5420 * containing a crate::ln::msgs::ChannelReestablish on success and a crate::ln::msgs::DecodeError on failure.
5421 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5423 typedef struct LDKCResult_ChannelReestablishDecodeErrorZ {
5425 * The contents of this CResult_ChannelReestablishDecodeErrorZ, accessible via either
5426 * `err` or `result` depending on the state of `result_ok`.
5428 union LDKCResult_ChannelReestablishDecodeErrorZPtr contents;
5430 * Whether this CResult_ChannelReestablishDecodeErrorZ represents a success state.
5433 } LDKCResult_ChannelReestablishDecodeErrorZ;
5436 * The contents of CResult_ClosingSignedDecodeErrorZ
5438 typedef union LDKCResult_ClosingSignedDecodeErrorZPtr {
5440 * A pointer to the contents in the success state.
5441 * Reading from this pointer when `result_ok` is not set is undefined.
5443 struct LDKClosingSigned *result;
5445 * A pointer to the contents in the error state.
5446 * Reading from this pointer when `result_ok` is set is undefined.
5448 struct LDKDecodeError *err;
5449 } LDKCResult_ClosingSignedDecodeErrorZPtr;
5452 * A CResult_ClosingSignedDecodeErrorZ represents the result of a fallible operation,
5453 * containing a crate::ln::msgs::ClosingSigned on success and a crate::ln::msgs::DecodeError on failure.
5454 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5456 typedef struct LDKCResult_ClosingSignedDecodeErrorZ {
5458 * The contents of this CResult_ClosingSignedDecodeErrorZ, accessible via either
5459 * `err` or `result` depending on the state of `result_ok`.
5461 union LDKCResult_ClosingSignedDecodeErrorZPtr contents;
5463 * Whether this CResult_ClosingSignedDecodeErrorZ represents a success state.
5466 } LDKCResult_ClosingSignedDecodeErrorZ;
5471 * A commitment_signed message to be sent or received from a peer
5473 typedef struct MUST_USE_STRUCT LDKCommitmentSigned {
5475 * A pointer to the opaque Rust object.
5476 * Nearly everywhere, inner must be non-null, however in places where
5477 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5479 LDKnativeCommitmentSigned *inner;
5481 * Indicates that this is the only struct which contains the same pointer.
5482 * Rust functions which take ownership of an object provided via an argument require
5483 * this to be true and invalidate the object pointed to by inner.
5486 } LDKCommitmentSigned;
5489 * The contents of CResult_CommitmentSignedDecodeErrorZ
5491 typedef union LDKCResult_CommitmentSignedDecodeErrorZPtr {
5493 * A pointer to the contents in the success state.
5494 * Reading from this pointer when `result_ok` is not set is undefined.
5496 struct LDKCommitmentSigned *result;
5498 * A pointer to the contents in the error state.
5499 * Reading from this pointer when `result_ok` is set is undefined.
5501 struct LDKDecodeError *err;
5502 } LDKCResult_CommitmentSignedDecodeErrorZPtr;
5505 * A CResult_CommitmentSignedDecodeErrorZ represents the result of a fallible operation,
5506 * containing a crate::ln::msgs::CommitmentSigned on success and a crate::ln::msgs::DecodeError on failure.
5507 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5509 typedef struct LDKCResult_CommitmentSignedDecodeErrorZ {
5511 * The contents of this CResult_CommitmentSignedDecodeErrorZ, accessible via either
5512 * `err` or `result` depending on the state of `result_ok`.
5514 union LDKCResult_CommitmentSignedDecodeErrorZPtr contents;
5516 * Whether this CResult_CommitmentSignedDecodeErrorZ represents a success state.
5519 } LDKCResult_CommitmentSignedDecodeErrorZ;
5522 * The contents of CResult_FundingCreatedDecodeErrorZ
5524 typedef union LDKCResult_FundingCreatedDecodeErrorZPtr {
5526 * A pointer to the contents in the success state.
5527 * Reading from this pointer when `result_ok` is not set is undefined.
5529 struct LDKFundingCreated *result;
5531 * A pointer to the contents in the error state.
5532 * Reading from this pointer when `result_ok` is set is undefined.
5534 struct LDKDecodeError *err;
5535 } LDKCResult_FundingCreatedDecodeErrorZPtr;
5538 * A CResult_FundingCreatedDecodeErrorZ represents the result of a fallible operation,
5539 * containing a crate::ln::msgs::FundingCreated on success and a crate::ln::msgs::DecodeError on failure.
5540 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5542 typedef struct LDKCResult_FundingCreatedDecodeErrorZ {
5544 * The contents of this CResult_FundingCreatedDecodeErrorZ, accessible via either
5545 * `err` or `result` depending on the state of `result_ok`.
5547 union LDKCResult_FundingCreatedDecodeErrorZPtr contents;
5549 * Whether this CResult_FundingCreatedDecodeErrorZ represents a success state.
5552 } LDKCResult_FundingCreatedDecodeErrorZ;
5555 * The contents of CResult_FundingSignedDecodeErrorZ
5557 typedef union LDKCResult_FundingSignedDecodeErrorZPtr {
5559 * A pointer to the contents in the success state.
5560 * Reading from this pointer when `result_ok` is not set is undefined.
5562 struct LDKFundingSigned *result;
5564 * A pointer to the contents in the error state.
5565 * Reading from this pointer when `result_ok` is set is undefined.
5567 struct LDKDecodeError *err;
5568 } LDKCResult_FundingSignedDecodeErrorZPtr;
5571 * A CResult_FundingSignedDecodeErrorZ represents the result of a fallible operation,
5572 * containing a crate::ln::msgs::FundingSigned on success and a crate::ln::msgs::DecodeError on failure.
5573 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5575 typedef struct LDKCResult_FundingSignedDecodeErrorZ {
5577 * The contents of this CResult_FundingSignedDecodeErrorZ, accessible via either
5578 * `err` or `result` depending on the state of `result_ok`.
5580 union LDKCResult_FundingSignedDecodeErrorZPtr contents;
5582 * Whether this CResult_FundingSignedDecodeErrorZ represents a success state.
5585 } LDKCResult_FundingSignedDecodeErrorZ;
5588 * The contents of CResult_FundingLockedDecodeErrorZ
5590 typedef union LDKCResult_FundingLockedDecodeErrorZPtr {
5592 * A pointer to the contents in the success state.
5593 * Reading from this pointer when `result_ok` is not set is undefined.
5595 struct LDKFundingLocked *result;
5597 * A pointer to the contents in the error state.
5598 * Reading from this pointer when `result_ok` is set is undefined.
5600 struct LDKDecodeError *err;
5601 } LDKCResult_FundingLockedDecodeErrorZPtr;
5604 * A CResult_FundingLockedDecodeErrorZ represents the result of a fallible operation,
5605 * containing a crate::ln::msgs::FundingLocked on success and a crate::ln::msgs::DecodeError on failure.
5606 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5608 typedef struct LDKCResult_FundingLockedDecodeErrorZ {
5610 * The contents of this CResult_FundingLockedDecodeErrorZ, accessible via either
5611 * `err` or `result` depending on the state of `result_ok`.
5613 union LDKCResult_FundingLockedDecodeErrorZPtr contents;
5615 * Whether this CResult_FundingLockedDecodeErrorZ represents a success state.
5618 } LDKCResult_FundingLockedDecodeErrorZ;
5623 * An init message to be sent or received from a peer
5625 typedef struct MUST_USE_STRUCT LDKInit {
5627 * A pointer to the opaque Rust object.
5628 * Nearly everywhere, inner must be non-null, however in places where
5629 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5631 LDKnativeInit *inner;
5633 * Indicates that this is the only struct which contains the same pointer.
5634 * Rust functions which take ownership of an object provided via an argument require
5635 * this to be true and invalidate the object pointed to by inner.
5641 * The contents of CResult_InitDecodeErrorZ
5643 typedef union LDKCResult_InitDecodeErrorZPtr {
5645 * A pointer to the contents in the success state.
5646 * Reading from this pointer when `result_ok` is not set is undefined.
5648 struct LDKInit *result;
5650 * A pointer to the contents in the error state.
5651 * Reading from this pointer when `result_ok` is set is undefined.
5653 struct LDKDecodeError *err;
5654 } LDKCResult_InitDecodeErrorZPtr;
5657 * A CResult_InitDecodeErrorZ represents the result of a fallible operation,
5658 * containing a crate::ln::msgs::Init on success and a crate::ln::msgs::DecodeError on failure.
5659 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5661 typedef struct LDKCResult_InitDecodeErrorZ {
5663 * The contents of this CResult_InitDecodeErrorZ, accessible via either
5664 * `err` or `result` depending on the state of `result_ok`.
5666 union LDKCResult_InitDecodeErrorZPtr contents;
5668 * Whether this CResult_InitDecodeErrorZ represents a success state.
5671 } LDKCResult_InitDecodeErrorZ;
5674 * The contents of CResult_OpenChannelDecodeErrorZ
5676 typedef union LDKCResult_OpenChannelDecodeErrorZPtr {
5678 * A pointer to the contents in the success state.
5679 * Reading from this pointer when `result_ok` is not set is undefined.
5681 struct LDKOpenChannel *result;
5683 * A pointer to the contents in the error state.
5684 * Reading from this pointer when `result_ok` is set is undefined.
5686 struct LDKDecodeError *err;
5687 } LDKCResult_OpenChannelDecodeErrorZPtr;
5690 * A CResult_OpenChannelDecodeErrorZ represents the result of a fallible operation,
5691 * containing a crate::ln::msgs::OpenChannel on success and a crate::ln::msgs::DecodeError on failure.
5692 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5694 typedef struct LDKCResult_OpenChannelDecodeErrorZ {
5696 * The contents of this CResult_OpenChannelDecodeErrorZ, accessible via either
5697 * `err` or `result` depending on the state of `result_ok`.
5699 union LDKCResult_OpenChannelDecodeErrorZPtr contents;
5701 * Whether this CResult_OpenChannelDecodeErrorZ represents a success state.
5704 } LDKCResult_OpenChannelDecodeErrorZ;
5707 * The contents of CResult_RevokeAndACKDecodeErrorZ
5709 typedef union LDKCResult_RevokeAndACKDecodeErrorZPtr {
5711 * A pointer to the contents in the success state.
5712 * Reading from this pointer when `result_ok` is not set is undefined.
5714 struct LDKRevokeAndACK *result;
5716 * A pointer to the contents in the error state.
5717 * Reading from this pointer when `result_ok` is set is undefined.
5719 struct LDKDecodeError *err;
5720 } LDKCResult_RevokeAndACKDecodeErrorZPtr;
5723 * A CResult_RevokeAndACKDecodeErrorZ represents the result of a fallible operation,
5724 * containing a crate::ln::msgs::RevokeAndACK on success and a crate::ln::msgs::DecodeError on failure.
5725 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5727 typedef struct LDKCResult_RevokeAndACKDecodeErrorZ {
5729 * The contents of this CResult_RevokeAndACKDecodeErrorZ, accessible via either
5730 * `err` or `result` depending on the state of `result_ok`.
5732 union LDKCResult_RevokeAndACKDecodeErrorZPtr contents;
5734 * Whether this CResult_RevokeAndACKDecodeErrorZ represents a success state.
5737 } LDKCResult_RevokeAndACKDecodeErrorZ;
5740 * The contents of CResult_ShutdownDecodeErrorZ
5742 typedef union LDKCResult_ShutdownDecodeErrorZPtr {
5744 * A pointer to the contents in the success state.
5745 * Reading from this pointer when `result_ok` is not set is undefined.
5747 struct LDKShutdown *result;
5749 * A pointer to the contents in the error state.
5750 * Reading from this pointer when `result_ok` is set is undefined.
5752 struct LDKDecodeError *err;
5753 } LDKCResult_ShutdownDecodeErrorZPtr;
5756 * A CResult_ShutdownDecodeErrorZ represents the result of a fallible operation,
5757 * containing a crate::ln::msgs::Shutdown on success and a crate::ln::msgs::DecodeError on failure.
5758 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5760 typedef struct LDKCResult_ShutdownDecodeErrorZ {
5762 * The contents of this CResult_ShutdownDecodeErrorZ, accessible via either
5763 * `err` or `result` depending on the state of `result_ok`.
5765 union LDKCResult_ShutdownDecodeErrorZPtr contents;
5767 * Whether this CResult_ShutdownDecodeErrorZ represents a success state.
5770 } LDKCResult_ShutdownDecodeErrorZ;
5773 * The contents of CResult_UpdateFailHTLCDecodeErrorZ
5775 typedef union LDKCResult_UpdateFailHTLCDecodeErrorZPtr {
5777 * A pointer to the contents in the success state.
5778 * Reading from this pointer when `result_ok` is not set is undefined.
5780 struct LDKUpdateFailHTLC *result;
5782 * A pointer to the contents in the error state.
5783 * Reading from this pointer when `result_ok` is set is undefined.
5785 struct LDKDecodeError *err;
5786 } LDKCResult_UpdateFailHTLCDecodeErrorZPtr;
5789 * A CResult_UpdateFailHTLCDecodeErrorZ represents the result of a fallible operation,
5790 * containing a crate::ln::msgs::UpdateFailHTLC on success and a crate::ln::msgs::DecodeError on failure.
5791 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5793 typedef struct LDKCResult_UpdateFailHTLCDecodeErrorZ {
5795 * The contents of this CResult_UpdateFailHTLCDecodeErrorZ, accessible via either
5796 * `err` or `result` depending on the state of `result_ok`.
5798 union LDKCResult_UpdateFailHTLCDecodeErrorZPtr contents;
5800 * Whether this CResult_UpdateFailHTLCDecodeErrorZ represents a success state.
5803 } LDKCResult_UpdateFailHTLCDecodeErrorZ;
5806 * The contents of CResult_UpdateFailMalformedHTLCDecodeErrorZ
5808 typedef union LDKCResult_UpdateFailMalformedHTLCDecodeErrorZPtr {
5810 * A pointer to the contents in the success state.
5811 * Reading from this pointer when `result_ok` is not set is undefined.
5813 struct LDKUpdateFailMalformedHTLC *result;
5815 * A pointer to the contents in the error state.
5816 * Reading from this pointer when `result_ok` is set is undefined.
5818 struct LDKDecodeError *err;
5819 } LDKCResult_UpdateFailMalformedHTLCDecodeErrorZPtr;
5822 * A CResult_UpdateFailMalformedHTLCDecodeErrorZ represents the result of a fallible operation,
5823 * containing a crate::ln::msgs::UpdateFailMalformedHTLC on success and a crate::ln::msgs::DecodeError on failure.
5824 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5826 typedef struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ {
5828 * The contents of this CResult_UpdateFailMalformedHTLCDecodeErrorZ, accessible via either
5829 * `err` or `result` depending on the state of `result_ok`.
5831 union LDKCResult_UpdateFailMalformedHTLCDecodeErrorZPtr contents;
5833 * Whether this CResult_UpdateFailMalformedHTLCDecodeErrorZ represents a success state.
5836 } LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ;
5841 * An update_fee message to be sent or received from a peer
5843 typedef struct MUST_USE_STRUCT LDKUpdateFee {
5845 * A pointer to the opaque Rust object.
5846 * Nearly everywhere, inner must be non-null, however in places where
5847 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5849 LDKnativeUpdateFee *inner;
5851 * Indicates that this is the only struct which contains the same pointer.
5852 * Rust functions which take ownership of an object provided via an argument require
5853 * this to be true and invalidate the object pointed to by inner.
5859 * The contents of CResult_UpdateFeeDecodeErrorZ
5861 typedef union LDKCResult_UpdateFeeDecodeErrorZPtr {
5863 * A pointer to the contents in the success state.
5864 * Reading from this pointer when `result_ok` is not set is undefined.
5866 struct LDKUpdateFee *result;
5868 * A pointer to the contents in the error state.
5869 * Reading from this pointer when `result_ok` is set is undefined.
5871 struct LDKDecodeError *err;
5872 } LDKCResult_UpdateFeeDecodeErrorZPtr;
5875 * A CResult_UpdateFeeDecodeErrorZ represents the result of a fallible operation,
5876 * containing a crate::ln::msgs::UpdateFee on success and a crate::ln::msgs::DecodeError on failure.
5877 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5879 typedef struct LDKCResult_UpdateFeeDecodeErrorZ {
5881 * The contents of this CResult_UpdateFeeDecodeErrorZ, accessible via either
5882 * `err` or `result` depending on the state of `result_ok`.
5884 union LDKCResult_UpdateFeeDecodeErrorZPtr contents;
5886 * Whether this CResult_UpdateFeeDecodeErrorZ represents a success state.
5889 } LDKCResult_UpdateFeeDecodeErrorZ;
5892 * The contents of CResult_UpdateFulfillHTLCDecodeErrorZ
5894 typedef union LDKCResult_UpdateFulfillHTLCDecodeErrorZPtr {
5896 * A pointer to the contents in the success state.
5897 * Reading from this pointer when `result_ok` is not set is undefined.
5899 struct LDKUpdateFulfillHTLC *result;
5901 * A pointer to the contents in the error state.
5902 * Reading from this pointer when `result_ok` is set is undefined.
5904 struct LDKDecodeError *err;
5905 } LDKCResult_UpdateFulfillHTLCDecodeErrorZPtr;
5908 * A CResult_UpdateFulfillHTLCDecodeErrorZ represents the result of a fallible operation,
5909 * containing a crate::ln::msgs::UpdateFulfillHTLC on success and a crate::ln::msgs::DecodeError on failure.
5910 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5912 typedef struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ {
5914 * The contents of this CResult_UpdateFulfillHTLCDecodeErrorZ, accessible via either
5915 * `err` or `result` depending on the state of `result_ok`.
5917 union LDKCResult_UpdateFulfillHTLCDecodeErrorZPtr contents;
5919 * Whether this CResult_UpdateFulfillHTLCDecodeErrorZ represents a success state.
5922 } LDKCResult_UpdateFulfillHTLCDecodeErrorZ;
5925 * The contents of CResult_UpdateAddHTLCDecodeErrorZ
5927 typedef union LDKCResult_UpdateAddHTLCDecodeErrorZPtr {
5929 * A pointer to the contents in the success state.
5930 * Reading from this pointer when `result_ok` is not set is undefined.
5932 struct LDKUpdateAddHTLC *result;
5934 * A pointer to the contents in the error state.
5935 * Reading from this pointer when `result_ok` is set is undefined.
5937 struct LDKDecodeError *err;
5938 } LDKCResult_UpdateAddHTLCDecodeErrorZPtr;
5941 * A CResult_UpdateAddHTLCDecodeErrorZ represents the result of a fallible operation,
5942 * containing a crate::ln::msgs::UpdateAddHTLC on success and a crate::ln::msgs::DecodeError on failure.
5943 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5945 typedef struct LDKCResult_UpdateAddHTLCDecodeErrorZ {
5947 * The contents of this CResult_UpdateAddHTLCDecodeErrorZ, accessible via either
5948 * `err` or `result` depending on the state of `result_ok`.
5950 union LDKCResult_UpdateAddHTLCDecodeErrorZPtr contents;
5952 * Whether this CResult_UpdateAddHTLCDecodeErrorZ represents a success state.
5955 } LDKCResult_UpdateAddHTLCDecodeErrorZ;
5960 * A ping message to be sent or received from a peer
5962 typedef struct MUST_USE_STRUCT LDKPing {
5964 * A pointer to the opaque Rust object.
5965 * Nearly everywhere, inner must be non-null, however in places where
5966 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5968 LDKnativePing *inner;
5970 * Indicates that this is the only struct which contains the same pointer.
5971 * Rust functions which take ownership of an object provided via an argument require
5972 * this to be true and invalidate the object pointed to by inner.
5978 * The contents of CResult_PingDecodeErrorZ
5980 typedef union LDKCResult_PingDecodeErrorZPtr {
5982 * A pointer to the contents in the success state.
5983 * Reading from this pointer when `result_ok` is not set is undefined.
5985 struct LDKPing *result;
5987 * A pointer to the contents in the error state.
5988 * Reading from this pointer when `result_ok` is set is undefined.
5990 struct LDKDecodeError *err;
5991 } LDKCResult_PingDecodeErrorZPtr;
5994 * A CResult_PingDecodeErrorZ represents the result of a fallible operation,
5995 * containing a crate::ln::msgs::Ping on success and a crate::ln::msgs::DecodeError on failure.
5996 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5998 typedef struct LDKCResult_PingDecodeErrorZ {
6000 * The contents of this CResult_PingDecodeErrorZ, accessible via either
6001 * `err` or `result` depending on the state of `result_ok`.
6003 union LDKCResult_PingDecodeErrorZPtr contents;
6005 * Whether this CResult_PingDecodeErrorZ represents a success state.
6008 } LDKCResult_PingDecodeErrorZ;
6013 * A pong message to be sent or received from a peer
6015 typedef struct MUST_USE_STRUCT LDKPong {
6017 * A pointer to the opaque Rust object.
6018 * Nearly everywhere, inner must be non-null, however in places where
6019 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6021 LDKnativePong *inner;
6023 * Indicates that this is the only struct which contains the same pointer.
6024 * Rust functions which take ownership of an object provided via an argument require
6025 * this to be true and invalidate the object pointed to by inner.
6031 * The contents of CResult_PongDecodeErrorZ
6033 typedef union LDKCResult_PongDecodeErrorZPtr {
6035 * A pointer to the contents in the success state.
6036 * Reading from this pointer when `result_ok` is not set is undefined.
6038 struct LDKPong *result;
6040 * A pointer to the contents in the error state.
6041 * Reading from this pointer when `result_ok` is set is undefined.
6043 struct LDKDecodeError *err;
6044 } LDKCResult_PongDecodeErrorZPtr;
6047 * A CResult_PongDecodeErrorZ represents the result of a fallible operation,
6048 * containing a crate::ln::msgs::Pong on success and a crate::ln::msgs::DecodeError on failure.
6049 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6051 typedef struct LDKCResult_PongDecodeErrorZ {
6053 * The contents of this CResult_PongDecodeErrorZ, accessible via either
6054 * `err` or `result` depending on the state of `result_ok`.
6056 union LDKCResult_PongDecodeErrorZPtr contents;
6058 * Whether this CResult_PongDecodeErrorZ represents a success state.
6061 } LDKCResult_PongDecodeErrorZ;
6064 * The contents of CResult_UnsignedChannelAnnouncementDecodeErrorZ
6066 typedef union LDKCResult_UnsignedChannelAnnouncementDecodeErrorZPtr {
6068 * A pointer to the contents in the success state.
6069 * Reading from this pointer when `result_ok` is not set is undefined.
6071 struct LDKUnsignedChannelAnnouncement *result;
6073 * A pointer to the contents in the error state.
6074 * Reading from this pointer when `result_ok` is set is undefined.
6076 struct LDKDecodeError *err;
6077 } LDKCResult_UnsignedChannelAnnouncementDecodeErrorZPtr;
6080 * A CResult_UnsignedChannelAnnouncementDecodeErrorZ represents the result of a fallible operation,
6081 * containing a crate::ln::msgs::UnsignedChannelAnnouncement on success and a crate::ln::msgs::DecodeError on failure.
6082 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6084 typedef struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ {
6086 * The contents of this CResult_UnsignedChannelAnnouncementDecodeErrorZ, accessible via either
6087 * `err` or `result` depending on the state of `result_ok`.
6089 union LDKCResult_UnsignedChannelAnnouncementDecodeErrorZPtr contents;
6091 * Whether this CResult_UnsignedChannelAnnouncementDecodeErrorZ represents a success state.
6094 } LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ;
6097 * The contents of CResult_ChannelAnnouncementDecodeErrorZ
6099 typedef union LDKCResult_ChannelAnnouncementDecodeErrorZPtr {
6101 * A pointer to the contents in the success state.
6102 * Reading from this pointer when `result_ok` is not set is undefined.
6104 struct LDKChannelAnnouncement *result;
6106 * A pointer to the contents in the error state.
6107 * Reading from this pointer when `result_ok` is set is undefined.
6109 struct LDKDecodeError *err;
6110 } LDKCResult_ChannelAnnouncementDecodeErrorZPtr;
6113 * A CResult_ChannelAnnouncementDecodeErrorZ represents the result of a fallible operation,
6114 * containing a crate::ln::msgs::ChannelAnnouncement on success and a crate::ln::msgs::DecodeError on failure.
6115 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6117 typedef struct LDKCResult_ChannelAnnouncementDecodeErrorZ {
6119 * The contents of this CResult_ChannelAnnouncementDecodeErrorZ, accessible via either
6120 * `err` or `result` depending on the state of `result_ok`.
6122 union LDKCResult_ChannelAnnouncementDecodeErrorZPtr contents;
6124 * Whether this CResult_ChannelAnnouncementDecodeErrorZ represents a success state.
6127 } LDKCResult_ChannelAnnouncementDecodeErrorZ;
6132 * The unsigned part of a channel_update
6134 typedef struct MUST_USE_STRUCT LDKUnsignedChannelUpdate {
6136 * A pointer to the opaque Rust object.
6137 * Nearly everywhere, inner must be non-null, however in places where
6138 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6140 LDKnativeUnsignedChannelUpdate *inner;
6142 * Indicates that this is the only struct which contains the same pointer.
6143 * Rust functions which take ownership of an object provided via an argument require
6144 * this to be true and invalidate the object pointed to by inner.
6147 } LDKUnsignedChannelUpdate;
6150 * The contents of CResult_UnsignedChannelUpdateDecodeErrorZ
6152 typedef union LDKCResult_UnsignedChannelUpdateDecodeErrorZPtr {
6154 * A pointer to the contents in the success state.
6155 * Reading from this pointer when `result_ok` is not set is undefined.
6157 struct LDKUnsignedChannelUpdate *result;
6159 * A pointer to the contents in the error state.
6160 * Reading from this pointer when `result_ok` is set is undefined.
6162 struct LDKDecodeError *err;
6163 } LDKCResult_UnsignedChannelUpdateDecodeErrorZPtr;
6166 * A CResult_UnsignedChannelUpdateDecodeErrorZ represents the result of a fallible operation,
6167 * containing a crate::ln::msgs::UnsignedChannelUpdate on success and a crate::ln::msgs::DecodeError on failure.
6168 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6170 typedef struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ {
6172 * The contents of this CResult_UnsignedChannelUpdateDecodeErrorZ, accessible via either
6173 * `err` or `result` depending on the state of `result_ok`.
6175 union LDKCResult_UnsignedChannelUpdateDecodeErrorZPtr contents;
6177 * Whether this CResult_UnsignedChannelUpdateDecodeErrorZ represents a success state.
6180 } LDKCResult_UnsignedChannelUpdateDecodeErrorZ;
6183 * The contents of CResult_ChannelUpdateDecodeErrorZ
6185 typedef union LDKCResult_ChannelUpdateDecodeErrorZPtr {
6187 * A pointer to the contents in the success state.
6188 * Reading from this pointer when `result_ok` is not set is undefined.
6190 struct LDKChannelUpdate *result;
6192 * A pointer to the contents in the error state.
6193 * Reading from this pointer when `result_ok` is set is undefined.
6195 struct LDKDecodeError *err;
6196 } LDKCResult_ChannelUpdateDecodeErrorZPtr;
6199 * A CResult_ChannelUpdateDecodeErrorZ represents the result of a fallible operation,
6200 * containing a crate::ln::msgs::ChannelUpdate on success and a crate::ln::msgs::DecodeError on failure.
6201 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6203 typedef struct LDKCResult_ChannelUpdateDecodeErrorZ {
6205 * The contents of this CResult_ChannelUpdateDecodeErrorZ, accessible via either
6206 * `err` or `result` depending on the state of `result_ok`.
6208 union LDKCResult_ChannelUpdateDecodeErrorZPtr contents;
6210 * Whether this CResult_ChannelUpdateDecodeErrorZ represents a success state.
6213 } LDKCResult_ChannelUpdateDecodeErrorZ;
6216 * The contents of CResult_ErrorMessageDecodeErrorZ
6218 typedef union LDKCResult_ErrorMessageDecodeErrorZPtr {
6220 * A pointer to the contents in the success state.
6221 * Reading from this pointer when `result_ok` is not set is undefined.
6223 struct LDKErrorMessage *result;
6225 * A pointer to the contents in the error state.
6226 * Reading from this pointer when `result_ok` is set is undefined.
6228 struct LDKDecodeError *err;
6229 } LDKCResult_ErrorMessageDecodeErrorZPtr;
6232 * A CResult_ErrorMessageDecodeErrorZ represents the result of a fallible operation,
6233 * containing a crate::ln::msgs::ErrorMessage on success and a crate::ln::msgs::DecodeError on failure.
6234 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6236 typedef struct LDKCResult_ErrorMessageDecodeErrorZ {
6238 * The contents of this CResult_ErrorMessageDecodeErrorZ, accessible via either
6239 * `err` or `result` depending on the state of `result_ok`.
6241 union LDKCResult_ErrorMessageDecodeErrorZPtr contents;
6243 * Whether this CResult_ErrorMessageDecodeErrorZ represents a success state.
6246 } LDKCResult_ErrorMessageDecodeErrorZ;
6251 * The unsigned part of a node_announcement
6253 typedef struct MUST_USE_STRUCT LDKUnsignedNodeAnnouncement {
6255 * A pointer to the opaque Rust object.
6256 * Nearly everywhere, inner must be non-null, however in places where
6257 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6259 LDKnativeUnsignedNodeAnnouncement *inner;
6261 * Indicates that this is the only struct which contains the same pointer.
6262 * Rust functions which take ownership of an object provided via an argument require
6263 * this to be true and invalidate the object pointed to by inner.
6266 } LDKUnsignedNodeAnnouncement;
6269 * The contents of CResult_UnsignedNodeAnnouncementDecodeErrorZ
6271 typedef union LDKCResult_UnsignedNodeAnnouncementDecodeErrorZPtr {
6273 * A pointer to the contents in the success state.
6274 * Reading from this pointer when `result_ok` is not set is undefined.
6276 struct LDKUnsignedNodeAnnouncement *result;
6278 * A pointer to the contents in the error state.
6279 * Reading from this pointer when `result_ok` is set is undefined.
6281 struct LDKDecodeError *err;
6282 } LDKCResult_UnsignedNodeAnnouncementDecodeErrorZPtr;
6285 * A CResult_UnsignedNodeAnnouncementDecodeErrorZ represents the result of a fallible operation,
6286 * containing a crate::ln::msgs::UnsignedNodeAnnouncement on success and a crate::ln::msgs::DecodeError on failure.
6287 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6289 typedef struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ {
6291 * The contents of this CResult_UnsignedNodeAnnouncementDecodeErrorZ, accessible via either
6292 * `err` or `result` depending on the state of `result_ok`.
6294 union LDKCResult_UnsignedNodeAnnouncementDecodeErrorZPtr contents;
6296 * Whether this CResult_UnsignedNodeAnnouncementDecodeErrorZ represents a success state.
6299 } LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ;
6302 * The contents of CResult_NodeAnnouncementDecodeErrorZ
6304 typedef union LDKCResult_NodeAnnouncementDecodeErrorZPtr {
6306 * A pointer to the contents in the success state.
6307 * Reading from this pointer when `result_ok` is not set is undefined.
6309 struct LDKNodeAnnouncement *result;
6311 * A pointer to the contents in the error state.
6312 * Reading from this pointer when `result_ok` is set is undefined.
6314 struct LDKDecodeError *err;
6315 } LDKCResult_NodeAnnouncementDecodeErrorZPtr;
6318 * A CResult_NodeAnnouncementDecodeErrorZ represents the result of a fallible operation,
6319 * containing a crate::ln::msgs::NodeAnnouncement on success and a crate::ln::msgs::DecodeError on failure.
6320 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6322 typedef struct LDKCResult_NodeAnnouncementDecodeErrorZ {
6324 * The contents of this CResult_NodeAnnouncementDecodeErrorZ, accessible via either
6325 * `err` or `result` depending on the state of `result_ok`.
6327 union LDKCResult_NodeAnnouncementDecodeErrorZPtr contents;
6329 * Whether this CResult_NodeAnnouncementDecodeErrorZ represents a success state.
6332 } LDKCResult_NodeAnnouncementDecodeErrorZ;
6335 * The contents of CResult_QueryShortChannelIdsDecodeErrorZ
6337 typedef union LDKCResult_QueryShortChannelIdsDecodeErrorZPtr {
6339 * A pointer to the contents in the success state.
6340 * Reading from this pointer when `result_ok` is not set is undefined.
6342 struct LDKQueryShortChannelIds *result;
6344 * A pointer to the contents in the error state.
6345 * Reading from this pointer when `result_ok` is set is undefined.
6347 struct LDKDecodeError *err;
6348 } LDKCResult_QueryShortChannelIdsDecodeErrorZPtr;
6351 * A CResult_QueryShortChannelIdsDecodeErrorZ represents the result of a fallible operation,
6352 * containing a crate::ln::msgs::QueryShortChannelIds on success and a crate::ln::msgs::DecodeError on failure.
6353 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6355 typedef struct LDKCResult_QueryShortChannelIdsDecodeErrorZ {
6357 * The contents of this CResult_QueryShortChannelIdsDecodeErrorZ, accessible via either
6358 * `err` or `result` depending on the state of `result_ok`.
6360 union LDKCResult_QueryShortChannelIdsDecodeErrorZPtr contents;
6362 * Whether this CResult_QueryShortChannelIdsDecodeErrorZ represents a success state.
6365 } LDKCResult_QueryShortChannelIdsDecodeErrorZ;
6370 * A reply_short_channel_ids_end message is sent as a reply to a
6371 * query_short_channel_ids message. The query recipient makes a best
6372 * effort to respond based on their local network view which may not be
6373 * a perfect view of the network.
6375 typedef struct MUST_USE_STRUCT LDKReplyShortChannelIdsEnd {
6377 * A pointer to the opaque Rust object.
6378 * Nearly everywhere, inner must be non-null, however in places where
6379 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6381 LDKnativeReplyShortChannelIdsEnd *inner;
6383 * Indicates that this is the only struct which contains the same pointer.
6384 * Rust functions which take ownership of an object provided via an argument require
6385 * this to be true and invalidate the object pointed to by inner.
6388 } LDKReplyShortChannelIdsEnd;
6391 * The contents of CResult_ReplyShortChannelIdsEndDecodeErrorZ
6393 typedef union LDKCResult_ReplyShortChannelIdsEndDecodeErrorZPtr {
6395 * A pointer to the contents in the success state.
6396 * Reading from this pointer when `result_ok` is not set is undefined.
6398 struct LDKReplyShortChannelIdsEnd *result;
6400 * A pointer to the contents in the error state.
6401 * Reading from this pointer when `result_ok` is set is undefined.
6403 struct LDKDecodeError *err;
6404 } LDKCResult_ReplyShortChannelIdsEndDecodeErrorZPtr;
6407 * A CResult_ReplyShortChannelIdsEndDecodeErrorZ represents the result of a fallible operation,
6408 * containing a crate::ln::msgs::ReplyShortChannelIdsEnd on success and a crate::ln::msgs::DecodeError on failure.
6409 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6411 typedef struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ {
6413 * The contents of this CResult_ReplyShortChannelIdsEndDecodeErrorZ, accessible via either
6414 * `err` or `result` depending on the state of `result_ok`.
6416 union LDKCResult_ReplyShortChannelIdsEndDecodeErrorZPtr contents;
6418 * Whether this CResult_ReplyShortChannelIdsEndDecodeErrorZ represents a success state.
6421 } LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ;
6424 * The contents of CResult_QueryChannelRangeDecodeErrorZ
6426 typedef union LDKCResult_QueryChannelRangeDecodeErrorZPtr {
6428 * A pointer to the contents in the success state.
6429 * Reading from this pointer when `result_ok` is not set is undefined.
6431 struct LDKQueryChannelRange *result;
6433 * A pointer to the contents in the error state.
6434 * Reading from this pointer when `result_ok` is set is undefined.
6436 struct LDKDecodeError *err;
6437 } LDKCResult_QueryChannelRangeDecodeErrorZPtr;
6440 * A CResult_QueryChannelRangeDecodeErrorZ represents the result of a fallible operation,
6441 * containing a crate::ln::msgs::QueryChannelRange on success and a crate::ln::msgs::DecodeError on failure.
6442 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6444 typedef struct LDKCResult_QueryChannelRangeDecodeErrorZ {
6446 * The contents of this CResult_QueryChannelRangeDecodeErrorZ, accessible via either
6447 * `err` or `result` depending on the state of `result_ok`.
6449 union LDKCResult_QueryChannelRangeDecodeErrorZPtr contents;
6451 * Whether this CResult_QueryChannelRangeDecodeErrorZ represents a success state.
6454 } LDKCResult_QueryChannelRangeDecodeErrorZ;
6457 * The contents of CResult_ReplyChannelRangeDecodeErrorZ
6459 typedef union LDKCResult_ReplyChannelRangeDecodeErrorZPtr {
6461 * A pointer to the contents in the success state.
6462 * Reading from this pointer when `result_ok` is not set is undefined.
6464 struct LDKReplyChannelRange *result;
6466 * A pointer to the contents in the error state.
6467 * Reading from this pointer when `result_ok` is set is undefined.
6469 struct LDKDecodeError *err;
6470 } LDKCResult_ReplyChannelRangeDecodeErrorZPtr;
6473 * A CResult_ReplyChannelRangeDecodeErrorZ represents the result of a fallible operation,
6474 * containing a crate::ln::msgs::ReplyChannelRange on success and a crate::ln::msgs::DecodeError on failure.
6475 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6477 typedef struct LDKCResult_ReplyChannelRangeDecodeErrorZ {
6479 * The contents of this CResult_ReplyChannelRangeDecodeErrorZ, accessible via either
6480 * `err` or `result` depending on the state of `result_ok`.
6482 union LDKCResult_ReplyChannelRangeDecodeErrorZPtr contents;
6484 * Whether this CResult_ReplyChannelRangeDecodeErrorZ represents a success state.
6487 } LDKCResult_ReplyChannelRangeDecodeErrorZ;
6492 * A gossip_timestamp_filter message is used by a node to request
6493 * gossip relay for messages in the requested time range when the
6494 * gossip_queries feature has been negotiated.
6496 typedef struct MUST_USE_STRUCT LDKGossipTimestampFilter {
6498 * A pointer to the opaque Rust object.
6499 * Nearly everywhere, inner must be non-null, however in places where
6500 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6502 LDKnativeGossipTimestampFilter *inner;
6504 * Indicates that this is the only struct which contains the same pointer.
6505 * Rust functions which take ownership of an object provided via an argument require
6506 * this to be true and invalidate the object pointed to by inner.
6509 } LDKGossipTimestampFilter;
6512 * The contents of CResult_GossipTimestampFilterDecodeErrorZ
6514 typedef union LDKCResult_GossipTimestampFilterDecodeErrorZPtr {
6516 * A pointer to the contents in the success state.
6517 * Reading from this pointer when `result_ok` is not set is undefined.
6519 struct LDKGossipTimestampFilter *result;
6521 * A pointer to the contents in the error state.
6522 * Reading from this pointer when `result_ok` is set is undefined.
6524 struct LDKDecodeError *err;
6525 } LDKCResult_GossipTimestampFilterDecodeErrorZPtr;
6528 * A CResult_GossipTimestampFilterDecodeErrorZ represents the result of a fallible operation,
6529 * containing a crate::ln::msgs::GossipTimestampFilter on success and a crate::ln::msgs::DecodeError on failure.
6530 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6532 typedef struct LDKCResult_GossipTimestampFilterDecodeErrorZ {
6534 * The contents of this CResult_GossipTimestampFilterDecodeErrorZ, accessible via either
6535 * `err` or `result` depending on the state of `result_ok`.
6537 union LDKCResult_GossipTimestampFilterDecodeErrorZPtr contents;
6539 * Whether this CResult_GossipTimestampFilterDecodeErrorZ represents a success state.
6542 } LDKCResult_GossipTimestampFilterDecodeErrorZ;
6545 * A trait indicating an object may generate message send events
6547 typedef struct LDKMessageSendEventsProvider {
6549 * An opaque pointer which is passed to your function implementations as an argument.
6550 * This has no meaning in the LDK, and can be NULL or any other value.
6554 * Gets the list of pending events which were generated by previous actions, clearing the list
6557 struct LDKCVec_MessageSendEventZ (*get_and_clear_pending_msg_events)(const void *this_arg);
6559 * Frees any resources associated with this object given its this_arg pointer.
6560 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
6562 void (*free)(void *this_arg);
6563 } LDKMessageSendEventsProvider;
6566 * A trait indicating an object may generate events
6568 typedef struct LDKEventsProvider {
6570 * An opaque pointer which is passed to your function implementations as an argument.
6571 * This has no meaning in the LDK, and can be NULL or any other value.
6575 * Gets the list of pending events which were generated by previous actions, clearing the list
6578 struct LDKCVec_EventZ (*get_and_clear_pending_events)(const void *this_arg);
6580 * Frees any resources associated with this object given its this_arg pointer.
6581 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
6583 void (*free)(void *this_arg);
6584 } LDKEventsProvider;
6589 * Configuration we set when applicable.
6591 * Default::default() provides sane defaults.
6593 typedef struct MUST_USE_STRUCT LDKChannelHandshakeConfig {
6595 * A pointer to the opaque Rust object.
6596 * Nearly everywhere, inner must be non-null, however in places where
6597 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6599 LDKnativeChannelHandshakeConfig *inner;
6601 * Indicates that this is the only struct which contains the same pointer.
6602 * Rust functions which take ownership of an object provided via an argument require
6603 * this to be true and invalidate the object pointed to by inner.
6606 } LDKChannelHandshakeConfig;
6611 * Optional channel limits which are applied during channel creation.
6613 * These limits are only applied to our counterparty's limits, not our own.
6615 * Use 0/<type>::max_value() as appropriate to skip checking.
6617 * Provides sane defaults for most configurations.
6619 * Most additional limits are disabled except those with which specify a default in individual
6620 * field documentation. Note that this may result in barely-usable channels, but since they
6621 * are applied mostly only to incoming channels that's not much of a problem.
6623 typedef struct MUST_USE_STRUCT LDKChannelHandshakeLimits {
6625 * A pointer to the opaque Rust object.
6626 * Nearly everywhere, inner must be non-null, however in places where
6627 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6629 LDKnativeChannelHandshakeLimits *inner;
6631 * Indicates that this is the only struct which contains the same pointer.
6632 * Rust functions which take ownership of an object provided via an argument require
6633 * this to be true and invalidate the object pointed to by inner.
6636 } LDKChannelHandshakeLimits;
6641 * Top-level config which holds ChannelHandshakeLimits and ChannelConfig.
6643 * Default::default() provides sane defaults for most configurations
6644 * (but currently with 0 relay fees!)
6646 typedef struct MUST_USE_STRUCT LDKUserConfig {
6648 * A pointer to the opaque Rust object.
6649 * Nearly everywhere, inner must be non-null, however in places where
6650 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6652 LDKnativeUserConfig *inner;
6654 * Indicates that this is the only struct which contains the same pointer.
6655 * Rust functions which take ownership of an object provided via an argument require
6656 * this to be true and invalidate the object pointed to by inner.
6662 * The `Access` trait defines behavior for accessing chain data and state, such as blocks and
6665 typedef struct LDKAccess {
6667 * An opaque pointer which is passed to your function implementations as an argument.
6668 * This has no meaning in the LDK, and can be NULL or any other value.
6672 * Returns the transaction output of a funding transaction encoded by [`short_channel_id`].
6673 * Returns an error if `genesis_hash` is for a different chain or if such a transaction output
6676 * [`short_channel_id`]: https://github.com/lightningnetwork/lightning-rfc/blob/master/07-routing-gossip.md#definition-of-short_channel_id
6678 struct LDKCResult_TxOutAccessErrorZ (*get_utxo)(const void *this_arg, const uint8_t (*genesis_hash)[32], uint64_t short_channel_id);
6680 * Frees any resources associated with this object given its this_arg pointer.
6681 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
6683 void (*free)(void *this_arg);
6687 * The `Listen` trait is used to be notified of when blocks have been connected or disconnected
6690 * Useful when needing to replay chain data upon startup or as new chain events occur.
6692 typedef struct LDKListen {
6694 * An opaque pointer which is passed to your function implementations as an argument.
6695 * This has no meaning in the LDK, and can be NULL or any other value.
6699 * Notifies the listener that a block was added at the given height.
6701 void (*block_connected)(const void *this_arg, struct LDKu8slice block, uint32_t height);
6703 * Notifies the listener that a block was removed at the given height.
6705 void (*block_disconnected)(const void *this_arg, const uint8_t (*header)[80], uint32_t height);
6707 * Frees any resources associated with this object given its this_arg pointer.
6708 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
6710 void (*free)(void *this_arg);
6716 * A transaction output watched by a [`ChannelMonitor`] for spends on-chain.
6718 * Used to convey to a [`Filter`] such an output with a given spending condition. Any transaction
6719 * spending the output must be given to [`ChannelMonitor::block_connected`] either directly or via
6720 * the return value of [`Filter::register_output`].
6722 * If `block_hash` is `Some`, this indicates the output was created in the corresponding block and
6723 * may have been spent there. See [`Filter::register_output`] for details.
6725 * [`ChannelMonitor`]: channelmonitor::ChannelMonitor
6726 * [`ChannelMonitor::block_connected`]: channelmonitor::ChannelMonitor::block_connected
6728 typedef struct MUST_USE_STRUCT LDKWatchedOutput {
6730 * A pointer to the opaque Rust object.
6731 * Nearly everywhere, inner must be non-null, however in places where
6732 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6734 LDKnativeWatchedOutput *inner;
6736 * Indicates that this is the only struct which contains the same pointer.
6737 * Rust functions which take ownership of an object provided via an argument require
6738 * this to be true and invalidate the object pointed to by inner.
6744 * The `Filter` trait defines behavior for indicating chain activity of interest pertaining to
6747 * This is useful in order to have a [`Watch`] implementation convey to a chain source which
6748 * transactions to be notified of. Notification may take the form of pre-filtering blocks or, in
6749 * the case of [BIP 157]/[BIP 158], only fetching a block if the compact filter matches. If
6750 * receiving full blocks from a chain source, any further filtering is unnecessary.
6752 * After an output has been registered, subsequent block retrievals from the chain source must not
6753 * exclude any transactions matching the new criteria nor any in-block descendants of such
6756 * Note that use as part of a [`Watch`] implementation involves reentrancy. Therefore, the `Filter`
6757 * should not block on I/O. Implementations should instead queue the newly monitored data to be
6758 * processed later. Then, in order to block until the data has been processed, any [`Watch`]
6759 * invocation that has called the `Filter` must return [`TemporaryFailure`].
6761 * [`TemporaryFailure`]: channelmonitor::ChannelMonitorUpdateErr::TemporaryFailure
6762 * [BIP 157]: https://github.com/bitcoin/bips/blob/master/bip-0157.mediawiki
6763 * [BIP 158]: https://github.com/bitcoin/bips/blob/master/bip-0158.mediawiki
6765 typedef struct LDKFilter {
6767 * An opaque pointer which is passed to your function implementations as an argument.
6768 * This has no meaning in the LDK, and can be NULL or any other value.
6772 * Registers interest in a transaction with `txid` and having an output with `script_pubkey` as
6773 * a spending condition.
6775 void (*register_tx)(const void *this_arg, const uint8_t (*txid)[32], struct LDKu8slice script_pubkey);
6777 * Registers interest in spends of a transaction output.
6779 * Optionally, when `output.block_hash` is set, should return any transaction spending the
6780 * output that is found in the corresponding block along with its index.
6782 * This return value is useful for Electrum clients in order to supply in-block descendant
6783 * transactions which otherwise were not included. This is not necessary for other clients if
6784 * such descendant transactions were already included (e.g., when a BIP 157 client provides the
6787 struct LDKCOption_C2Tuple_usizeTransactionZZ (*register_output)(const void *this_arg, struct LDKWatchedOutput output);
6789 * Frees any resources associated with this object given its this_arg pointer.
6790 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
6792 void (*free)(void *this_arg);
6796 * `Persist` defines behavior for persisting channel monitors: this could mean
6797 * writing once to disk, and/or uploading to one or more backup services.
6799 * Note that for every new monitor, you **must** persist the new `ChannelMonitor`
6800 * to disk/backups. And, on every update, you **must** persist either the
6801 * `ChannelMonitorUpdate` or the updated monitor itself. Otherwise, there is risk
6802 * of situations such as revoking a transaction, then crashing before this
6803 * revocation can be persisted, then unintentionally broadcasting a revoked
6804 * transaction and losing money. This is a risk because previous channel states
6805 * are toxic, so it's important that whatever channel state is persisted is
6808 typedef struct LDKPersist {
6810 * An opaque pointer which is passed to your function implementations as an argument.
6811 * This has no meaning in the LDK, and can be NULL or any other value.
6815 * Persist a new channel's data. The data can be stored any way you want, but
6816 * the identifier provided by Rust-Lightning is the channel's outpoint (and
6817 * it is up to you to maintain a correct mapping between the outpoint and the
6818 * stored channel data). Note that you **must** persist every new monitor to
6819 * disk. See the `Persist` trait documentation for more details.
6821 * See [`ChannelMonitor::write`] for writing out a `ChannelMonitor`,
6822 * and [`ChannelMonitorUpdateErr`] for requirements when returning errors.
6824 struct LDKCResult_NoneChannelMonitorUpdateErrZ (*persist_new_channel)(const void *this_arg, struct LDKOutPoint id, const struct LDKChannelMonitor *NONNULL_PTR data);
6826 * Update one channel's data. The provided `ChannelMonitor` has already
6827 * applied the given update.
6829 * Note that on every update, you **must** persist either the
6830 * `ChannelMonitorUpdate` or the updated monitor itself to disk/backups. See
6831 * the `Persist` trait documentation for more details.
6833 * If an implementer chooses to persist the updates only, they need to make
6834 * sure that all the updates are applied to the `ChannelMonitors` *before*
6835 * the set of channel monitors is given to the `ChannelManager`
6836 * deserialization routine. See [`ChannelMonitor::update_monitor`] for
6837 * applying a monitor update to a monitor. If full `ChannelMonitors` are
6838 * persisted, then there is no need to persist individual updates.
6840 * Note that there could be a performance tradeoff between persisting complete
6841 * channel monitors on every update vs. persisting only updates and applying
6842 * them in batches. The size of each monitor grows `O(number of state updates)`
6843 * whereas updates are small and `O(1)`.
6845 * See [`ChannelMonitor::write`] for writing out a `ChannelMonitor`,
6846 * [`ChannelMonitorUpdate::write`] for writing out an update, and
6847 * [`ChannelMonitorUpdateErr`] for requirements when returning errors.
6849 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);
6851 * Frees any resources associated with this object given its this_arg pointer.
6852 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
6854 void (*free)(void *this_arg);
6860 * An implementation of [`chain::Watch`] for monitoring channels.
6862 * Connected and disconnected blocks must be provided to `ChainMonitor` as documented by
6863 * [`chain::Watch`]. May be used in conjunction with [`ChannelManager`] to monitor channels locally
6864 * or used independently to monitor channels remotely. See the [module-level documentation] for
6867 * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
6868 * [module-level documentation]: crate::chain::chainmonitor
6870 typedef struct MUST_USE_STRUCT LDKChainMonitor {
6872 * A pointer to the opaque Rust object.
6873 * Nearly everywhere, inner must be non-null, however in places where
6874 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6876 LDKnativeChainMonitor *inner;
6878 * Indicates that this is the only struct which contains the same pointer.
6879 * Rust functions which take ownership of an object provided via an argument require
6880 * this to be true and invalidate the object pointed to by inner.
6888 * Simple KeysInterface implementor that takes a 32-byte seed for use as a BIP 32 extended key
6889 * and derives keys from that.
6891 * Your node_id is seed/0'
6892 * ChannelMonitor closes may use seed/1'
6893 * Cooperative closes may use seed/2'
6894 * The two close keys may be needed to claim on-chain funds!
6896 typedef struct MUST_USE_STRUCT LDKKeysManager {
6898 * A pointer to the opaque Rust object.
6899 * Nearly everywhere, inner must be non-null, however in places where
6900 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6902 LDKnativeKeysManager *inner;
6904 * Indicates that this is the only struct which contains the same pointer.
6905 * Rust functions which take ownership of an object provided via an argument require
6906 * this to be true and invalidate the object pointed to by inner.
6914 * Chain-related parameters used to construct a new `ChannelManager`.
6916 * Typically, the block-specific parameters are derived from the best block hash for the network,
6917 * as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
6918 * are not needed when deserializing a previously constructed `ChannelManager`.
6920 typedef struct MUST_USE_STRUCT LDKChainParameters {
6922 * A pointer to the opaque Rust object.
6923 * Nearly everywhere, inner must be non-null, however in places where
6924 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6926 LDKnativeChainParameters *inner;
6928 * Indicates that this is the only struct which contains the same pointer.
6929 * Rust functions which take ownership of an object provided via an argument require
6930 * this to be true and invalidate the object pointed to by inner.
6933 } LDKChainParameters;
6936 * A 3-byte byte array.
6938 typedef struct LDKThreeBytes {
6946 * A trait to describe an object which can receive channel messages.
6948 * Messages MAY be called in parallel when they originate from different their_node_ids, however
6949 * they MUST NOT be called in parallel when the two calls have the same their_node_id.
6951 typedef struct LDKChannelMessageHandler {
6953 * An opaque pointer which is passed to your function implementations as an argument.
6954 * This has no meaning in the LDK, and can be NULL or any other value.
6958 * Handle an incoming open_channel message from the given peer.
6960 void (*handle_open_channel)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKInitFeatures their_features, const struct LDKOpenChannel *NONNULL_PTR msg);
6962 * Handle an incoming accept_channel message from the given peer.
6964 void (*handle_accept_channel)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKInitFeatures their_features, const struct LDKAcceptChannel *NONNULL_PTR msg);
6966 * Handle an incoming funding_created message from the given peer.
6968 void (*handle_funding_created)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKFundingCreated *NONNULL_PTR msg);
6970 * Handle an incoming funding_signed message from the given peer.
6972 void (*handle_funding_signed)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKFundingSigned *NONNULL_PTR msg);
6974 * Handle an incoming funding_locked message from the given peer.
6976 void (*handle_funding_locked)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKFundingLocked *NONNULL_PTR msg);
6978 * Handle an incoming shutdown message from the given peer.
6980 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);
6982 * Handle an incoming closing_signed message from the given peer.
6984 void (*handle_closing_signed)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKClosingSigned *NONNULL_PTR msg);
6986 * Handle an incoming update_add_htlc message from the given peer.
6988 void (*handle_update_add_htlc)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKUpdateAddHTLC *NONNULL_PTR msg);
6990 * Handle an incoming update_fulfill_htlc message from the given peer.
6992 void (*handle_update_fulfill_htlc)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKUpdateFulfillHTLC *NONNULL_PTR msg);
6994 * Handle an incoming update_fail_htlc message from the given peer.
6996 void (*handle_update_fail_htlc)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKUpdateFailHTLC *NONNULL_PTR msg);
6998 * Handle an incoming update_fail_malformed_htlc message from the given peer.
7000 void (*handle_update_fail_malformed_htlc)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR msg);
7002 * Handle an incoming commitment_signed message from the given peer.
7004 void (*handle_commitment_signed)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKCommitmentSigned *NONNULL_PTR msg);
7006 * Handle an incoming revoke_and_ack message from the given peer.
7008 void (*handle_revoke_and_ack)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKRevokeAndACK *NONNULL_PTR msg);
7010 * Handle an incoming update_fee message from the given peer.
7012 void (*handle_update_fee)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKUpdateFee *NONNULL_PTR msg);
7014 * Handle an incoming announcement_signatures message from the given peer.
7016 void (*handle_announcement_signatures)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKAnnouncementSignatures *NONNULL_PTR msg);
7018 * Indicates a connection to the peer failed/an existing connection was lost. If no connection
7019 * is believed to be possible in the future (eg they're sending us messages we don't
7020 * understand or indicate they require unknown feature bits), no_connection_possible is set
7021 * and any outstanding channels should be failed.
7023 void (*peer_disconnected)(const void *this_arg, struct LDKPublicKey their_node_id, bool no_connection_possible);
7025 * Handle a peer reconnecting, possibly generating channel_reestablish message(s).
7027 void (*peer_connected)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKInit *NONNULL_PTR msg);
7029 * Handle an incoming channel_reestablish message from the given peer.
7031 void (*handle_channel_reestablish)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKChannelReestablish *NONNULL_PTR msg);
7033 * Handle an incoming channel update from the given peer.
7035 void (*handle_channel_update)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKChannelUpdate *NONNULL_PTR msg);
7037 * Handle an incoming error message from the given peer.
7039 void (*handle_error)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKErrorMessage *NONNULL_PTR msg);
7041 * Implementation of MessageSendEventsProvider for this object.
7043 struct LDKMessageSendEventsProvider MessageSendEventsProvider;
7045 * Frees any resources associated with this object given its this_arg pointer.
7046 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
7048 void (*free)(void *this_arg);
7049 } LDKChannelMessageHandler;
7054 * Arguments for the creation of a ChannelManager that are not deserialized.
7056 * At a high-level, the process for deserializing a ChannelManager and resuming normal operation
7058 * 1) Deserialize all stored ChannelMonitors.
7059 * 2) Deserialize the ChannelManager by filling in this struct and calling:
7060 * <(BlockHash, ChannelManager)>::read(reader, args)
7061 * This may result in closing some Channels if the ChannelMonitor is newer than the stored
7062 * ChannelManager state to ensure no loss of funds. Thus, transactions may be broadcasted.
7063 * 3) If you are not fetching full blocks, register all relevant ChannelMonitor outpoints the same
7064 * way you would handle a `chain::Filter` call using ChannelMonitor::get_outputs_to_watch() and
7065 * ChannelMonitor::get_funding_txo().
7066 * 4) Reconnect blocks on your ChannelMonitors.
7067 * 5) Disconnect/connect blocks on the ChannelManager.
7068 * 6) Move the ChannelMonitors into your local chain::Watch.
7070 * Note that the ordering of #4-6 is not of importance, however all three must occur before you
7071 * call any other methods on the newly-deserialized ChannelManager.
7073 * Note that because some channels may be closed during deserialization, it is critical that you
7074 * always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
7075 * you. If you deserialize an old ChannelManager (during which force-closure transactions may be
7076 * broadcast), and then later deserialize a newer version of the same ChannelManager (which will
7077 * not force-close the same channels but consider them live), you may end up revoking a state for
7078 * which you've already broadcasted the transaction.
7080 typedef struct MUST_USE_STRUCT LDKChannelManagerReadArgs {
7082 * A pointer to the opaque Rust object.
7083 * Nearly everywhere, inner must be non-null, however in places where
7084 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7086 LDKnativeChannelManagerReadArgs *inner;
7088 * Indicates that this is the only struct which contains the same pointer.
7089 * Rust functions which take ownership of an object provided via an argument require
7090 * this to be true and invalidate the object pointed to by inner.
7093 } LDKChannelManagerReadArgs;
7098 * Proof that the sender knows the per-commitment secret of the previous commitment transaction.
7099 * This is used to convince the recipient that the channel is at a certain commitment
7100 * number even if they lost that data due to a local failure. Of course, the peer may lie
7101 * and even later commitments may have been revoked.
7103 typedef struct MUST_USE_STRUCT LDKDataLossProtect {
7105 * A pointer to the opaque Rust object.
7106 * Nearly everywhere, inner must be non-null, however in places where
7107 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7109 LDKnativeDataLossProtect *inner;
7111 * Indicates that this is the only struct which contains the same pointer.
7112 * Rust functions which take ownership of an object provided via an argument require
7113 * this to be true and invalidate the object pointed to by inner.
7116 } LDKDataLossProtect;
7119 * A trait to describe an object which can receive routing messages.
7121 * # Implementor DoS Warnings
7123 * For `gossip_queries` messages there are potential DoS vectors when handling
7124 * inbound queries. Implementors using an on-disk network graph should be aware of
7125 * repeated disk I/O for queries accessing different parts of the network graph.
7127 typedef struct LDKRoutingMessageHandler {
7129 * An opaque pointer which is passed to your function implementations as an argument.
7130 * This has no meaning in the LDK, and can be NULL or any other value.
7134 * Handle an incoming node_announcement message, returning true if it should be forwarded on,
7135 * false or returning an Err otherwise.
7137 struct LDKCResult_boolLightningErrorZ (*handle_node_announcement)(const void *this_arg, const struct LDKNodeAnnouncement *NONNULL_PTR msg);
7139 * Handle a channel_announcement message, returning true if it should be forwarded on, false
7140 * or returning an Err otherwise.
7142 struct LDKCResult_boolLightningErrorZ (*handle_channel_announcement)(const void *this_arg, const struct LDKChannelAnnouncement *NONNULL_PTR msg);
7144 * Handle an incoming channel_update message, returning true if it should be forwarded on,
7145 * false or returning an Err otherwise.
7147 struct LDKCResult_boolLightningErrorZ (*handle_channel_update)(const void *this_arg, const struct LDKChannelUpdate *NONNULL_PTR msg);
7149 * Handle some updates to the route graph that we learned due to an outbound failed payment.
7151 void (*handle_htlc_fail_channel_update)(const void *this_arg, const struct LDKHTLCFailChannelUpdate *NONNULL_PTR update);
7153 * Gets a subset of the channel announcements and updates required to dump our routing table
7154 * to a remote node, starting at the short_channel_id indicated by starting_point and
7155 * including the batch_amount entries immediately higher in numerical value than starting_point.
7157 struct LDKCVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ (*get_next_channel_announcements)(const void *this_arg, uint64_t starting_point, uint8_t batch_amount);
7159 * Gets a subset of the node announcements required to dump our routing table to a remote node,
7160 * starting at the node *after* the provided publickey and including batch_amount entries
7161 * immediately higher (as defined by <PublicKey as Ord>::cmp) than starting_point.
7162 * If None is provided for starting_point, we start at the first node.
7164 struct LDKCVec_NodeAnnouncementZ (*get_next_node_announcements)(const void *this_arg, struct LDKPublicKey starting_point, uint8_t batch_amount);
7166 * Called when a connection is established with a peer. This can be used to
7167 * perform routing table synchronization using a strategy defined by the
7170 void (*sync_routing_table)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKInit *NONNULL_PTR init);
7172 * Handles the reply of a query we initiated to learn about channels
7173 * for a given range of blocks. We can expect to receive one or more
7174 * replies to a single query.
7176 struct LDKCResult_NoneLightningErrorZ (*handle_reply_channel_range)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKReplyChannelRange msg);
7178 * Handles the reply of a query we initiated asking for routing gossip
7179 * messages for a list of channels. We should receive this message when
7180 * a node has completed its best effort to send us the pertaining routing
7183 struct LDKCResult_NoneLightningErrorZ (*handle_reply_short_channel_ids_end)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKReplyShortChannelIdsEnd msg);
7185 * Handles when a peer asks us to send a list of short_channel_ids
7186 * for the requested range of blocks.
7188 struct LDKCResult_NoneLightningErrorZ (*handle_query_channel_range)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKQueryChannelRange msg);
7190 * Handles when a peer asks us to send routing gossip messages for a
7191 * list of short_channel_ids.
7193 struct LDKCResult_NoneLightningErrorZ (*handle_query_short_channel_ids)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKQueryShortChannelIds msg);
7195 * Implementation of MessageSendEventsProvider for this object.
7197 struct LDKMessageSendEventsProvider MessageSendEventsProvider;
7199 * Frees any resources associated with this object given its this_arg pointer.
7200 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
7202 void (*free)(void *this_arg);
7203 } LDKRoutingMessageHandler;
7208 * A dummy struct which implements `RoutingMessageHandler` without storing any routing information
7209 * or doing any processing. You can provide one of these as the route_handler in a MessageHandler.
7211 typedef struct MUST_USE_STRUCT LDKIgnoringMessageHandler {
7213 * A pointer to the opaque Rust object.
7214 * Nearly everywhere, inner must be non-null, however in places where
7215 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7217 LDKnativeIgnoringMessageHandler *inner;
7219 * Indicates that this is the only struct which contains the same pointer.
7220 * Rust functions which take ownership of an object provided via an argument require
7221 * this to be true and invalidate the object pointed to by inner.
7224 } LDKIgnoringMessageHandler;
7229 * A dummy struct which implements `ChannelMessageHandler` without having any channels.
7230 * You can provide one of these as the route_handler in a MessageHandler.
7232 typedef struct MUST_USE_STRUCT LDKErroringMessageHandler {
7234 * A pointer to the opaque Rust object.
7235 * Nearly everywhere, inner must be non-null, however in places where
7236 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7238 LDKnativeErroringMessageHandler *inner;
7240 * Indicates that this is the only struct which contains the same pointer.
7241 * Rust functions which take ownership of an object provided via an argument require
7242 * this to be true and invalidate the object pointed to by inner.
7245 } LDKErroringMessageHandler;
7250 * Provides references to trait impls which handle different types of messages.
7252 typedef struct MUST_USE_STRUCT LDKMessageHandler {
7254 * A pointer to the opaque Rust object.
7255 * Nearly everywhere, inner must be non-null, however in places where
7256 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7258 LDKnativeMessageHandler *inner;
7260 * Indicates that this is the only struct which contains the same pointer.
7261 * Rust functions which take ownership of an object provided via an argument require
7262 * this to be true and invalidate the object pointed to by inner.
7265 } LDKMessageHandler;
7268 * Provides an object which can be used to send data to and which uniquely identifies a connection
7269 * to a remote host. You will need to be able to generate multiple of these which meet Eq and
7270 * implement Hash to meet the PeerManager API.
7272 * For efficiency, Clone should be relatively cheap for this type.
7274 * You probably want to just extend an int and put a file descriptor in a struct and implement
7275 * send_data. Note that if you are using a higher-level net library that may call close() itself,
7276 * be careful to ensure you don't have races whereby you might register a new connection with an
7277 * fd which is the same as a previous one which has yet to be removed via
7278 * PeerManager::socket_disconnected().
7280 typedef struct LDKSocketDescriptor {
7282 * An opaque pointer which is passed to your function implementations as an argument.
7283 * This has no meaning in the LDK, and can be NULL or any other value.
7287 * Attempts to send some data from the given slice to the peer.
7289 * Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
7290 * Note that in the disconnected case, socket_disconnected must still fire and further write
7291 * attempts may occur until that time.
7293 * If the returned size is smaller than data.len(), a write_available event must
7294 * trigger the next time more data can be written. Additionally, until the a send_data event
7295 * completes fully, no further read_events should trigger on the same peer!
7297 * If a read_event on this descriptor had previously returned true (indicating that read
7298 * events should be paused to prevent DoS in the send buffer), resume_read may be set
7299 * indicating that read events on this descriptor should resume. A resume_read of false does
7300 * *not* imply that further read events should be paused.
7302 uintptr_t (*send_data)(void *this_arg, struct LDKu8slice data, bool resume_read);
7304 * Disconnect the socket pointed to by this SocketDescriptor. Once this function returns, no
7305 * more calls to write_buffer_space_avail, read_event or socket_disconnected may be made with
7306 * this descriptor. No socket_disconnected call should be generated as a result of this call,
7307 * though races may occur whereby disconnect_socket is called after a call to
7308 * socket_disconnected but prior to socket_disconnected returning.
7310 void (*disconnect_socket)(void *this_arg);
7312 * Checks if two objects are equal given this object's this_arg pointer and another object.
7314 bool (*eq)(const void *this_arg, const struct LDKSocketDescriptor *NONNULL_PTR other_arg);
7316 * Calculate a succinct non-cryptographic hash for an object given its this_arg pointer.
7317 * This is used, for example, for inclusion of this object in a hash map.
7319 uint64_t (*hash)(const void *this_arg);
7321 * Creates a copy of the object pointed to by this_arg, for a copy of this SocketDescriptor.
7322 * Note that the ultimate copy of the SocketDescriptor will have all function pointers the same as the original.
7323 * May be NULL if no action needs to be taken, the this_arg pointer will be copied into the new SocketDescriptor.
7325 void *(*clone)(const void *this_arg);
7327 * Frees any resources associated with this object given its this_arg pointer.
7328 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
7330 void (*free)(void *this_arg);
7331 } LDKSocketDescriptor;
7336 * A PeerManager manages a set of peers, described by their SocketDescriptor and marshalls socket
7337 * events into messages which it passes on to its MessageHandlers.
7339 * Rather than using a plain PeerManager, it is preferable to use either a SimpleArcPeerManager
7340 * a SimpleRefPeerManager, for conciseness. See their documentation for more details, but
7341 * essentially you should default to using a SimpleRefPeerManager, and use a
7342 * SimpleArcPeerManager when you require a PeerManager with a static lifetime, such as when
7343 * you're using lightning-net-tokio.
7345 typedef struct MUST_USE_STRUCT LDKPeerManager {
7347 * A pointer to the opaque Rust object.
7348 * Nearly everywhere, inner must be non-null, however in places where
7349 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7351 LDKnativePeerManager *inner;
7353 * Indicates that this is the only struct which contains the same pointer.
7354 * Rust functions which take ownership of an object provided via an argument require
7355 * this to be true and invalidate the object pointed to by inner.
7363 * Static channel fields used to build transactions given per-commitment fields, organized by
7364 * broadcaster/countersignatory.
7366 * This is derived from the holder/counterparty-organized ChannelTransactionParameters via the
7367 * as_holder_broadcastable and as_counterparty_broadcastable functions.
7369 typedef struct MUST_USE_STRUCT LDKDirectedChannelTransactionParameters {
7371 * A pointer to the opaque Rust object.
7372 * Nearly everywhere, inner must be non-null, however in places where
7373 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7375 LDKnativeDirectedChannelTransactionParameters *inner;
7377 * Indicates that this is the only struct which contains the same pointer.
7378 * Rust functions which take ownership of an object provided via an argument require
7379 * this to be true and invalidate the object pointed to by inner.
7382 } LDKDirectedChannelTransactionParameters;
7387 * A simple newtype for RwLockReadGuard<'a, NetworkGraph>.
7388 * This exists only to make accessing a RwLock<NetworkGraph> possible from
7389 * the C bindings, as it can be done directly in Rust code.
7391 typedef struct MUST_USE_STRUCT LDKLockedNetworkGraph {
7393 * A pointer to the opaque Rust object.
7394 * Nearly everywhere, inner must be non-null, however in places where
7395 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7397 LDKnativeLockedNetworkGraph *inner;
7399 * Indicates that this is the only struct which contains the same pointer.
7400 * Rust functions which take ownership of an object provided via an argument require
7401 * this to be true and invalidate the object pointed to by inner.
7404 } LDKLockedNetworkGraph;
7409 * Receives and validates network updates from peers,
7410 * stores authentic and relevant data as a network graph.
7411 * This network graph is then used for routing payments.
7412 * Provides interface to help with initial routing sync by
7413 * serving historical announcements.
7415 typedef struct MUST_USE_STRUCT LDKNetGraphMsgHandler {
7417 * A pointer to the opaque Rust object.
7418 * Nearly everywhere, inner must be non-null, however in places where
7419 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7421 LDKnativeNetGraphMsgHandler *inner;
7423 * Indicates that this is the only struct which contains the same pointer.
7424 * Rust functions which take ownership of an object provided via an argument require
7425 * this to be true and invalidate the object pointed to by inner.
7428 } LDKNetGraphMsgHandler;
7430 extern const uintptr_t MAX_BUF_SIZE;
7432 extern const uint64_t MIN_RELAY_FEE_SAT_PER_1000_WEIGHT;
7434 extern const uint64_t CLOSED_CHANNEL_UPDATE_ID;
7436 extern const uint16_t BREAKDOWN_TIMEOUT;
7438 extern const uint16_t MIN_CLTV_EXPIRY_DELTA;
7440 extern const uintptr_t REVOKEABLE_REDEEMSCRIPT_MAX_LENGTH;
7443 * Frees the data buffer, if data_is_owned is set and datalen > 0.
7445 void Transaction_free(struct LDKTransaction _res);
7448 * Frees the data pointed to by script_pubkey.
7450 void TxOut_free(struct LDKTxOut _res);
7453 * Creates a new TxOut which has the same data as `orig` but with a new script buffer.
7455 struct LDKTxOut TxOut_clone(const struct LDKTxOut *NONNULL_PTR orig);
7458 * Creates a new CResult_SecretKeyErrorZ in the success state.
7460 struct LDKCResult_SecretKeyErrorZ CResult_SecretKeyErrorZ_ok(struct LDKSecretKey o);
7463 * Creates a new CResult_SecretKeyErrorZ in the error state.
7465 struct LDKCResult_SecretKeyErrorZ CResult_SecretKeyErrorZ_err(enum LDKSecp256k1Error e);
7468 * Frees any resources used by the CResult_SecretKeyErrorZ.
7470 void CResult_SecretKeyErrorZ_free(struct LDKCResult_SecretKeyErrorZ _res);
7473 * Creates a new CResult_PublicKeyErrorZ in the success state.
7475 struct LDKCResult_PublicKeyErrorZ CResult_PublicKeyErrorZ_ok(struct LDKPublicKey o);
7478 * Creates a new CResult_PublicKeyErrorZ in the error state.
7480 struct LDKCResult_PublicKeyErrorZ CResult_PublicKeyErrorZ_err(enum LDKSecp256k1Error e);
7483 * Frees any resources used by the CResult_PublicKeyErrorZ.
7485 void CResult_PublicKeyErrorZ_free(struct LDKCResult_PublicKeyErrorZ _res);
7488 * Creates a new CResult_TxCreationKeysDecodeErrorZ in the success state.
7490 struct LDKCResult_TxCreationKeysDecodeErrorZ CResult_TxCreationKeysDecodeErrorZ_ok(struct LDKTxCreationKeys o);
7493 * Creates a new CResult_TxCreationKeysDecodeErrorZ in the error state.
7495 struct LDKCResult_TxCreationKeysDecodeErrorZ CResult_TxCreationKeysDecodeErrorZ_err(struct LDKDecodeError e);
7498 * Frees any resources used by the CResult_TxCreationKeysDecodeErrorZ.
7500 void CResult_TxCreationKeysDecodeErrorZ_free(struct LDKCResult_TxCreationKeysDecodeErrorZ _res);
7503 * Creates a new CResult_TxCreationKeysDecodeErrorZ which has the same data as `orig`
7504 * but with all dynamically-allocated buffers duplicated in new buffers.
7506 struct LDKCResult_TxCreationKeysDecodeErrorZ CResult_TxCreationKeysDecodeErrorZ_clone(const struct LDKCResult_TxCreationKeysDecodeErrorZ *NONNULL_PTR orig);
7509 * Creates a new CResult_ChannelPublicKeysDecodeErrorZ in the success state.
7511 struct LDKCResult_ChannelPublicKeysDecodeErrorZ CResult_ChannelPublicKeysDecodeErrorZ_ok(struct LDKChannelPublicKeys o);
7514 * Creates a new CResult_ChannelPublicKeysDecodeErrorZ in the error state.
7516 struct LDKCResult_ChannelPublicKeysDecodeErrorZ CResult_ChannelPublicKeysDecodeErrorZ_err(struct LDKDecodeError e);
7519 * Frees any resources used by the CResult_ChannelPublicKeysDecodeErrorZ.
7521 void CResult_ChannelPublicKeysDecodeErrorZ_free(struct LDKCResult_ChannelPublicKeysDecodeErrorZ _res);
7524 * Creates a new CResult_ChannelPublicKeysDecodeErrorZ which has the same data as `orig`
7525 * but with all dynamically-allocated buffers duplicated in new buffers.
7527 struct LDKCResult_ChannelPublicKeysDecodeErrorZ CResult_ChannelPublicKeysDecodeErrorZ_clone(const struct LDKCResult_ChannelPublicKeysDecodeErrorZ *NONNULL_PTR orig);
7530 * Creates a new CResult_TxCreationKeysErrorZ in the success state.
7532 struct LDKCResult_TxCreationKeysErrorZ CResult_TxCreationKeysErrorZ_ok(struct LDKTxCreationKeys o);
7535 * Creates a new CResult_TxCreationKeysErrorZ in the error state.
7537 struct LDKCResult_TxCreationKeysErrorZ CResult_TxCreationKeysErrorZ_err(enum LDKSecp256k1Error e);
7540 * Frees any resources used by the CResult_TxCreationKeysErrorZ.
7542 void CResult_TxCreationKeysErrorZ_free(struct LDKCResult_TxCreationKeysErrorZ _res);
7545 * Constructs a new COption_u32Z containing a u32
7547 struct LDKCOption_u32Z COption_u32Z_some(uint32_t o);
7550 * Constructs a new COption_u32Z containing nothing
7552 struct LDKCOption_u32Z COption_u32Z_none(void);
7555 * Frees any resources associated with the u32, if we are in the Some state
7557 void COption_u32Z_free(struct LDKCOption_u32Z _res);
7560 * Creates a new COption_u32Z which has the same data as `orig`
7561 * but with all dynamically-allocated buffers duplicated in new buffers.
7563 struct LDKCOption_u32Z COption_u32Z_clone(const struct LDKCOption_u32Z *NONNULL_PTR orig);
7566 * Creates a new CResult_HTLCOutputInCommitmentDecodeErrorZ in the success state.
7568 struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ CResult_HTLCOutputInCommitmentDecodeErrorZ_ok(struct LDKHTLCOutputInCommitment o);
7571 * Creates a new CResult_HTLCOutputInCommitmentDecodeErrorZ in the error state.
7573 struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ CResult_HTLCOutputInCommitmentDecodeErrorZ_err(struct LDKDecodeError e);
7576 * Frees any resources used by the CResult_HTLCOutputInCommitmentDecodeErrorZ.
7578 void CResult_HTLCOutputInCommitmentDecodeErrorZ_free(struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ _res);
7581 * Creates a new CResult_HTLCOutputInCommitmentDecodeErrorZ which has the same data as `orig`
7582 * but with all dynamically-allocated buffers duplicated in new buffers.
7584 struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ CResult_HTLCOutputInCommitmentDecodeErrorZ_clone(const struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ *NONNULL_PTR orig);
7587 * Creates a new CResult_CounterpartyChannelTransactionParametersDecodeErrorZ in the success state.
7589 struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ CResult_CounterpartyChannelTransactionParametersDecodeErrorZ_ok(struct LDKCounterpartyChannelTransactionParameters o);
7592 * Creates a new CResult_CounterpartyChannelTransactionParametersDecodeErrorZ in the error state.
7594 struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ CResult_CounterpartyChannelTransactionParametersDecodeErrorZ_err(struct LDKDecodeError e);
7597 * Frees any resources used by the CResult_CounterpartyChannelTransactionParametersDecodeErrorZ.
7599 void CResult_CounterpartyChannelTransactionParametersDecodeErrorZ_free(struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ _res);
7602 * Creates a new CResult_CounterpartyChannelTransactionParametersDecodeErrorZ which has the same data as `orig`
7603 * but with all dynamically-allocated buffers duplicated in new buffers.
7605 struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ CResult_CounterpartyChannelTransactionParametersDecodeErrorZ_clone(const struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ *NONNULL_PTR orig);
7608 * Creates a new CResult_ChannelTransactionParametersDecodeErrorZ in the success state.
7610 struct LDKCResult_ChannelTransactionParametersDecodeErrorZ CResult_ChannelTransactionParametersDecodeErrorZ_ok(struct LDKChannelTransactionParameters o);
7613 * Creates a new CResult_ChannelTransactionParametersDecodeErrorZ in the error state.
7615 struct LDKCResult_ChannelTransactionParametersDecodeErrorZ CResult_ChannelTransactionParametersDecodeErrorZ_err(struct LDKDecodeError e);
7618 * Frees any resources used by the CResult_ChannelTransactionParametersDecodeErrorZ.
7620 void CResult_ChannelTransactionParametersDecodeErrorZ_free(struct LDKCResult_ChannelTransactionParametersDecodeErrorZ _res);
7623 * Creates a new CResult_ChannelTransactionParametersDecodeErrorZ which has the same data as `orig`
7624 * but with all dynamically-allocated buffers duplicated in new buffers.
7626 struct LDKCResult_ChannelTransactionParametersDecodeErrorZ CResult_ChannelTransactionParametersDecodeErrorZ_clone(const struct LDKCResult_ChannelTransactionParametersDecodeErrorZ *NONNULL_PTR orig);
7629 * Frees the buffer pointed to by `data` if `datalen` is non-0.
7631 void CVec_SignatureZ_free(struct LDKCVec_SignatureZ _res);
7634 * Creates a new CResult_HolderCommitmentTransactionDecodeErrorZ in the success state.
7636 struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ CResult_HolderCommitmentTransactionDecodeErrorZ_ok(struct LDKHolderCommitmentTransaction o);
7639 * Creates a new CResult_HolderCommitmentTransactionDecodeErrorZ in the error state.
7641 struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ CResult_HolderCommitmentTransactionDecodeErrorZ_err(struct LDKDecodeError e);
7644 * Frees any resources used by the CResult_HolderCommitmentTransactionDecodeErrorZ.
7646 void CResult_HolderCommitmentTransactionDecodeErrorZ_free(struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ _res);
7649 * Creates a new CResult_HolderCommitmentTransactionDecodeErrorZ which has the same data as `orig`
7650 * but with all dynamically-allocated buffers duplicated in new buffers.
7652 struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ CResult_HolderCommitmentTransactionDecodeErrorZ_clone(const struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ *NONNULL_PTR orig);
7655 * Creates a new CResult_BuiltCommitmentTransactionDecodeErrorZ in the success state.
7657 struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ CResult_BuiltCommitmentTransactionDecodeErrorZ_ok(struct LDKBuiltCommitmentTransaction o);
7660 * Creates a new CResult_BuiltCommitmentTransactionDecodeErrorZ in the error state.
7662 struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ CResult_BuiltCommitmentTransactionDecodeErrorZ_err(struct LDKDecodeError e);
7665 * Frees any resources used by the CResult_BuiltCommitmentTransactionDecodeErrorZ.
7667 void CResult_BuiltCommitmentTransactionDecodeErrorZ_free(struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ _res);
7670 * Creates a new CResult_BuiltCommitmentTransactionDecodeErrorZ which has the same data as `orig`
7671 * but with all dynamically-allocated buffers duplicated in new buffers.
7673 struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ CResult_BuiltCommitmentTransactionDecodeErrorZ_clone(const struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ *NONNULL_PTR orig);
7676 * Creates a new CResult_CommitmentTransactionDecodeErrorZ in the success state.
7678 struct LDKCResult_CommitmentTransactionDecodeErrorZ CResult_CommitmentTransactionDecodeErrorZ_ok(struct LDKCommitmentTransaction o);
7681 * Creates a new CResult_CommitmentTransactionDecodeErrorZ in the error state.
7683 struct LDKCResult_CommitmentTransactionDecodeErrorZ CResult_CommitmentTransactionDecodeErrorZ_err(struct LDKDecodeError e);
7686 * Frees any resources used by the CResult_CommitmentTransactionDecodeErrorZ.
7688 void CResult_CommitmentTransactionDecodeErrorZ_free(struct LDKCResult_CommitmentTransactionDecodeErrorZ _res);
7691 * Creates a new CResult_CommitmentTransactionDecodeErrorZ which has the same data as `orig`
7692 * but with all dynamically-allocated buffers duplicated in new buffers.
7694 struct LDKCResult_CommitmentTransactionDecodeErrorZ CResult_CommitmentTransactionDecodeErrorZ_clone(const struct LDKCResult_CommitmentTransactionDecodeErrorZ *NONNULL_PTR orig);
7697 * Creates a new CResult_TrustedCommitmentTransactionNoneZ in the success state.
7699 struct LDKCResult_TrustedCommitmentTransactionNoneZ CResult_TrustedCommitmentTransactionNoneZ_ok(struct LDKTrustedCommitmentTransaction o);
7702 * Creates a new CResult_TrustedCommitmentTransactionNoneZ in the error state.
7704 struct LDKCResult_TrustedCommitmentTransactionNoneZ CResult_TrustedCommitmentTransactionNoneZ_err(void);
7707 * Frees any resources used by the CResult_TrustedCommitmentTransactionNoneZ.
7709 void CResult_TrustedCommitmentTransactionNoneZ_free(struct LDKCResult_TrustedCommitmentTransactionNoneZ _res);
7712 * Creates a new CResult_CVec_SignatureZNoneZ in the success state.
7714 struct LDKCResult_CVec_SignatureZNoneZ CResult_CVec_SignatureZNoneZ_ok(struct LDKCVec_SignatureZ o);
7717 * Creates a new CResult_CVec_SignatureZNoneZ in the error state.
7719 struct LDKCResult_CVec_SignatureZNoneZ CResult_CVec_SignatureZNoneZ_err(void);
7722 * Frees any resources used by the CResult_CVec_SignatureZNoneZ.
7724 void CResult_CVec_SignatureZNoneZ_free(struct LDKCResult_CVec_SignatureZNoneZ _res);
7727 * Creates a new CResult_CVec_SignatureZNoneZ which has the same data as `orig`
7728 * but with all dynamically-allocated buffers duplicated in new buffers.
7730 struct LDKCResult_CVec_SignatureZNoneZ CResult_CVec_SignatureZNoneZ_clone(const struct LDKCResult_CVec_SignatureZNoneZ *NONNULL_PTR orig);
7733 * Frees the buffer pointed to by `data` if `datalen` is non-0.
7735 void CVec_MessageSendEventZ_free(struct LDKCVec_MessageSendEventZ _res);
7738 * Creates a new CResult_boolLightningErrorZ in the success state.
7740 struct LDKCResult_boolLightningErrorZ CResult_boolLightningErrorZ_ok(bool o);
7743 * Creates a new CResult_boolLightningErrorZ in the error state.
7745 struct LDKCResult_boolLightningErrorZ CResult_boolLightningErrorZ_err(struct LDKLightningError e);
7748 * Frees any resources used by the CResult_boolLightningErrorZ.
7750 void CResult_boolLightningErrorZ_free(struct LDKCResult_boolLightningErrorZ _res);
7753 * Creates a new CResult_boolLightningErrorZ which has the same data as `orig`
7754 * but with all dynamically-allocated buffers duplicated in new buffers.
7756 struct LDKCResult_boolLightningErrorZ CResult_boolLightningErrorZ_clone(const struct LDKCResult_boolLightningErrorZ *NONNULL_PTR orig);
7759 * Creates a new tuple which has the same data as `orig`
7760 * but with all dynamically-allocated buffers duplicated in new buffers.
7762 struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ_clone(const struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ *NONNULL_PTR orig);
7765 * Creates a new C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ from the contained elements.
7767 struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ_new(struct LDKChannelAnnouncement a, struct LDKChannelUpdate b, struct LDKChannelUpdate c);
7770 * Frees any resources used by the C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ.
7772 void C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ_free(struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ _res);
7775 * Frees the buffer pointed to by `data` if `datalen` is non-0.
7777 void CVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ_free(struct LDKCVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ _res);
7780 * Frees the buffer pointed to by `data` if `datalen` is non-0.
7782 void CVec_NodeAnnouncementZ_free(struct LDKCVec_NodeAnnouncementZ _res);
7785 * Creates a new CResult_NoneLightningErrorZ in the success state.
7787 struct LDKCResult_NoneLightningErrorZ CResult_NoneLightningErrorZ_ok(void);
7790 * Creates a new CResult_NoneLightningErrorZ in the error state.
7792 struct LDKCResult_NoneLightningErrorZ CResult_NoneLightningErrorZ_err(struct LDKLightningError e);
7795 * Frees any resources used by the CResult_NoneLightningErrorZ.
7797 void CResult_NoneLightningErrorZ_free(struct LDKCResult_NoneLightningErrorZ _res);
7800 * Creates a new CResult_NoneLightningErrorZ which has the same data as `orig`
7801 * but with all dynamically-allocated buffers duplicated in new buffers.
7803 struct LDKCResult_NoneLightningErrorZ CResult_NoneLightningErrorZ_clone(const struct LDKCResult_NoneLightningErrorZ *NONNULL_PTR orig);
7806 * Frees the buffer pointed to by `data` if `datalen` is non-0.
7808 void CVec_PublicKeyZ_free(struct LDKCVec_PublicKeyZ _res);
7811 * Frees the buffer pointed to by `data` if `datalen` is non-0.
7813 void CVec_u8Z_free(struct LDKCVec_u8Z _res);
7816 * Creates a new CResult_CVec_u8ZPeerHandleErrorZ in the success state.
7818 struct LDKCResult_CVec_u8ZPeerHandleErrorZ CResult_CVec_u8ZPeerHandleErrorZ_ok(struct LDKCVec_u8Z o);
7821 * Creates a new CResult_CVec_u8ZPeerHandleErrorZ in the error state.
7823 struct LDKCResult_CVec_u8ZPeerHandleErrorZ CResult_CVec_u8ZPeerHandleErrorZ_err(struct LDKPeerHandleError e);
7826 * Frees any resources used by the CResult_CVec_u8ZPeerHandleErrorZ.
7828 void CResult_CVec_u8ZPeerHandleErrorZ_free(struct LDKCResult_CVec_u8ZPeerHandleErrorZ _res);
7831 * Creates a new CResult_CVec_u8ZPeerHandleErrorZ which has the same data as `orig`
7832 * but with all dynamically-allocated buffers duplicated in new buffers.
7834 struct LDKCResult_CVec_u8ZPeerHandleErrorZ CResult_CVec_u8ZPeerHandleErrorZ_clone(const struct LDKCResult_CVec_u8ZPeerHandleErrorZ *NONNULL_PTR orig);
7837 * Creates a new CResult_NonePeerHandleErrorZ in the success state.
7839 struct LDKCResult_NonePeerHandleErrorZ CResult_NonePeerHandleErrorZ_ok(void);
7842 * Creates a new CResult_NonePeerHandleErrorZ in the error state.
7844 struct LDKCResult_NonePeerHandleErrorZ CResult_NonePeerHandleErrorZ_err(struct LDKPeerHandleError e);
7847 * Frees any resources used by the CResult_NonePeerHandleErrorZ.
7849 void CResult_NonePeerHandleErrorZ_free(struct LDKCResult_NonePeerHandleErrorZ _res);
7852 * Creates a new CResult_NonePeerHandleErrorZ which has the same data as `orig`
7853 * but with all dynamically-allocated buffers duplicated in new buffers.
7855 struct LDKCResult_NonePeerHandleErrorZ CResult_NonePeerHandleErrorZ_clone(const struct LDKCResult_NonePeerHandleErrorZ *NONNULL_PTR orig);
7858 * Creates a new CResult_boolPeerHandleErrorZ in the success state.
7860 struct LDKCResult_boolPeerHandleErrorZ CResult_boolPeerHandleErrorZ_ok(bool o);
7863 * Creates a new CResult_boolPeerHandleErrorZ in the error state.
7865 struct LDKCResult_boolPeerHandleErrorZ CResult_boolPeerHandleErrorZ_err(struct LDKPeerHandleError e);
7868 * Frees any resources used by the CResult_boolPeerHandleErrorZ.
7870 void CResult_boolPeerHandleErrorZ_free(struct LDKCResult_boolPeerHandleErrorZ _res);
7873 * Creates a new CResult_boolPeerHandleErrorZ which has the same data as `orig`
7874 * but with all dynamically-allocated buffers duplicated in new buffers.
7876 struct LDKCResult_boolPeerHandleErrorZ CResult_boolPeerHandleErrorZ_clone(const struct LDKCResult_boolPeerHandleErrorZ *NONNULL_PTR orig);
7879 * Creates a new CResult_InitFeaturesDecodeErrorZ in the success state.
7881 struct LDKCResult_InitFeaturesDecodeErrorZ CResult_InitFeaturesDecodeErrorZ_ok(struct LDKInitFeatures o);
7884 * Creates a new CResult_InitFeaturesDecodeErrorZ in the error state.
7886 struct LDKCResult_InitFeaturesDecodeErrorZ CResult_InitFeaturesDecodeErrorZ_err(struct LDKDecodeError e);
7889 * Frees any resources used by the CResult_InitFeaturesDecodeErrorZ.
7891 void CResult_InitFeaturesDecodeErrorZ_free(struct LDKCResult_InitFeaturesDecodeErrorZ _res);
7894 * Creates a new CResult_NodeFeaturesDecodeErrorZ in the success state.
7896 struct LDKCResult_NodeFeaturesDecodeErrorZ CResult_NodeFeaturesDecodeErrorZ_ok(struct LDKNodeFeatures o);
7899 * Creates a new CResult_NodeFeaturesDecodeErrorZ in the error state.
7901 struct LDKCResult_NodeFeaturesDecodeErrorZ CResult_NodeFeaturesDecodeErrorZ_err(struct LDKDecodeError e);
7904 * Frees any resources used by the CResult_NodeFeaturesDecodeErrorZ.
7906 void CResult_NodeFeaturesDecodeErrorZ_free(struct LDKCResult_NodeFeaturesDecodeErrorZ _res);
7909 * Creates a new CResult_ChannelFeaturesDecodeErrorZ in the success state.
7911 struct LDKCResult_ChannelFeaturesDecodeErrorZ CResult_ChannelFeaturesDecodeErrorZ_ok(struct LDKChannelFeatures o);
7914 * Creates a new CResult_ChannelFeaturesDecodeErrorZ in the error state.
7916 struct LDKCResult_ChannelFeaturesDecodeErrorZ CResult_ChannelFeaturesDecodeErrorZ_err(struct LDKDecodeError e);
7919 * Frees any resources used by the CResult_ChannelFeaturesDecodeErrorZ.
7921 void CResult_ChannelFeaturesDecodeErrorZ_free(struct LDKCResult_ChannelFeaturesDecodeErrorZ _res);
7924 * Creates a new CResult_InvoiceFeaturesDecodeErrorZ in the success state.
7926 struct LDKCResult_InvoiceFeaturesDecodeErrorZ CResult_InvoiceFeaturesDecodeErrorZ_ok(struct LDKInvoiceFeatures o);
7929 * Creates a new CResult_InvoiceFeaturesDecodeErrorZ in the error state.
7931 struct LDKCResult_InvoiceFeaturesDecodeErrorZ CResult_InvoiceFeaturesDecodeErrorZ_err(struct LDKDecodeError e);
7934 * Frees any resources used by the CResult_InvoiceFeaturesDecodeErrorZ.
7936 void CResult_InvoiceFeaturesDecodeErrorZ_free(struct LDKCResult_InvoiceFeaturesDecodeErrorZ _res);
7939 * Creates a new CResult_ChannelConfigDecodeErrorZ in the success state.
7941 struct LDKCResult_ChannelConfigDecodeErrorZ CResult_ChannelConfigDecodeErrorZ_ok(struct LDKChannelConfig o);
7944 * Creates a new CResult_ChannelConfigDecodeErrorZ in the error state.
7946 struct LDKCResult_ChannelConfigDecodeErrorZ CResult_ChannelConfigDecodeErrorZ_err(struct LDKDecodeError e);
7949 * Frees any resources used by the CResult_ChannelConfigDecodeErrorZ.
7951 void CResult_ChannelConfigDecodeErrorZ_free(struct LDKCResult_ChannelConfigDecodeErrorZ _res);
7954 * Creates a new CResult_ChannelConfigDecodeErrorZ which has the same data as `orig`
7955 * but with all dynamically-allocated buffers duplicated in new buffers.
7957 struct LDKCResult_ChannelConfigDecodeErrorZ CResult_ChannelConfigDecodeErrorZ_clone(const struct LDKCResult_ChannelConfigDecodeErrorZ *NONNULL_PTR orig);
7960 * Constructs a new COption_u64Z containing a u64
7962 struct LDKCOption_u64Z COption_u64Z_some(uint64_t o);
7965 * Constructs a new COption_u64Z containing nothing
7967 struct LDKCOption_u64Z COption_u64Z_none(void);
7970 * Frees any resources associated with the u64, if we are in the Some state
7972 void COption_u64Z_free(struct LDKCOption_u64Z _res);
7975 * Creates a new COption_u64Z which has the same data as `orig`
7976 * but with all dynamically-allocated buffers duplicated in new buffers.
7978 struct LDKCOption_u64Z COption_u64Z_clone(const struct LDKCOption_u64Z *NONNULL_PTR orig);
7981 * Creates a new CResult_DirectionalChannelInfoDecodeErrorZ in the success state.
7983 struct LDKCResult_DirectionalChannelInfoDecodeErrorZ CResult_DirectionalChannelInfoDecodeErrorZ_ok(struct LDKDirectionalChannelInfo o);
7986 * Creates a new CResult_DirectionalChannelInfoDecodeErrorZ in the error state.
7988 struct LDKCResult_DirectionalChannelInfoDecodeErrorZ CResult_DirectionalChannelInfoDecodeErrorZ_err(struct LDKDecodeError e);
7991 * Frees any resources used by the CResult_DirectionalChannelInfoDecodeErrorZ.
7993 void CResult_DirectionalChannelInfoDecodeErrorZ_free(struct LDKCResult_DirectionalChannelInfoDecodeErrorZ _res);
7996 * Creates a new CResult_DirectionalChannelInfoDecodeErrorZ which has the same data as `orig`
7997 * but with all dynamically-allocated buffers duplicated in new buffers.
7999 struct LDKCResult_DirectionalChannelInfoDecodeErrorZ CResult_DirectionalChannelInfoDecodeErrorZ_clone(const struct LDKCResult_DirectionalChannelInfoDecodeErrorZ *NONNULL_PTR orig);
8002 * Creates a new CResult_ChannelInfoDecodeErrorZ in the success state.
8004 struct LDKCResult_ChannelInfoDecodeErrorZ CResult_ChannelInfoDecodeErrorZ_ok(struct LDKChannelInfo o);
8007 * Creates a new CResult_ChannelInfoDecodeErrorZ in the error state.
8009 struct LDKCResult_ChannelInfoDecodeErrorZ CResult_ChannelInfoDecodeErrorZ_err(struct LDKDecodeError e);
8012 * Frees any resources used by the CResult_ChannelInfoDecodeErrorZ.
8014 void CResult_ChannelInfoDecodeErrorZ_free(struct LDKCResult_ChannelInfoDecodeErrorZ _res);
8017 * Creates a new CResult_ChannelInfoDecodeErrorZ which has the same data as `orig`
8018 * but with all dynamically-allocated buffers duplicated in new buffers.
8020 struct LDKCResult_ChannelInfoDecodeErrorZ CResult_ChannelInfoDecodeErrorZ_clone(const struct LDKCResult_ChannelInfoDecodeErrorZ *NONNULL_PTR orig);
8023 * Creates a new CResult_RoutingFeesDecodeErrorZ in the success state.
8025 struct LDKCResult_RoutingFeesDecodeErrorZ CResult_RoutingFeesDecodeErrorZ_ok(struct LDKRoutingFees o);
8028 * Creates a new CResult_RoutingFeesDecodeErrorZ in the error state.
8030 struct LDKCResult_RoutingFeesDecodeErrorZ CResult_RoutingFeesDecodeErrorZ_err(struct LDKDecodeError e);
8033 * Frees any resources used by the CResult_RoutingFeesDecodeErrorZ.
8035 void CResult_RoutingFeesDecodeErrorZ_free(struct LDKCResult_RoutingFeesDecodeErrorZ _res);
8038 * Creates a new CResult_RoutingFeesDecodeErrorZ which has the same data as `orig`
8039 * but with all dynamically-allocated buffers duplicated in new buffers.
8041 struct LDKCResult_RoutingFeesDecodeErrorZ CResult_RoutingFeesDecodeErrorZ_clone(const struct LDKCResult_RoutingFeesDecodeErrorZ *NONNULL_PTR orig);
8044 * Frees the buffer pointed to by `data` if `datalen` is non-0.
8046 void CVec_NetAddressZ_free(struct LDKCVec_NetAddressZ _res);
8049 * Creates a new CResult_NodeAnnouncementInfoDecodeErrorZ in the success state.
8051 struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ CResult_NodeAnnouncementInfoDecodeErrorZ_ok(struct LDKNodeAnnouncementInfo o);
8054 * Creates a new CResult_NodeAnnouncementInfoDecodeErrorZ in the error state.
8056 struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ CResult_NodeAnnouncementInfoDecodeErrorZ_err(struct LDKDecodeError e);
8059 * Frees any resources used by the CResult_NodeAnnouncementInfoDecodeErrorZ.
8061 void CResult_NodeAnnouncementInfoDecodeErrorZ_free(struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ _res);
8064 * Creates a new CResult_NodeAnnouncementInfoDecodeErrorZ which has the same data as `orig`
8065 * but with all dynamically-allocated buffers duplicated in new buffers.
8067 struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ CResult_NodeAnnouncementInfoDecodeErrorZ_clone(const struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ *NONNULL_PTR orig);
8070 * Frees the buffer pointed to by `data` if `datalen` is non-0.
8072 void CVec_u64Z_free(struct LDKCVec_u64Z _res);
8075 * Creates a new CResult_NodeInfoDecodeErrorZ in the success state.
8077 struct LDKCResult_NodeInfoDecodeErrorZ CResult_NodeInfoDecodeErrorZ_ok(struct LDKNodeInfo o);
8080 * Creates a new CResult_NodeInfoDecodeErrorZ in the error state.
8082 struct LDKCResult_NodeInfoDecodeErrorZ CResult_NodeInfoDecodeErrorZ_err(struct LDKDecodeError e);
8085 * Frees any resources used by the CResult_NodeInfoDecodeErrorZ.
8087 void CResult_NodeInfoDecodeErrorZ_free(struct LDKCResult_NodeInfoDecodeErrorZ _res);
8090 * Creates a new CResult_NodeInfoDecodeErrorZ which has the same data as `orig`
8091 * but with all dynamically-allocated buffers duplicated in new buffers.
8093 struct LDKCResult_NodeInfoDecodeErrorZ CResult_NodeInfoDecodeErrorZ_clone(const struct LDKCResult_NodeInfoDecodeErrorZ *NONNULL_PTR orig);
8096 * Creates a new CResult_NetworkGraphDecodeErrorZ in the success state.
8098 struct LDKCResult_NetworkGraphDecodeErrorZ CResult_NetworkGraphDecodeErrorZ_ok(struct LDKNetworkGraph o);
8101 * Creates a new CResult_NetworkGraphDecodeErrorZ in the error state.
8103 struct LDKCResult_NetworkGraphDecodeErrorZ CResult_NetworkGraphDecodeErrorZ_err(struct LDKDecodeError e);
8106 * Frees any resources used by the CResult_NetworkGraphDecodeErrorZ.
8108 void CResult_NetworkGraphDecodeErrorZ_free(struct LDKCResult_NetworkGraphDecodeErrorZ _res);
8111 * Creates a new CResult_NetworkGraphDecodeErrorZ which has the same data as `orig`
8112 * but with all dynamically-allocated buffers duplicated in new buffers.
8114 struct LDKCResult_NetworkGraphDecodeErrorZ CResult_NetworkGraphDecodeErrorZ_clone(const struct LDKCResult_NetworkGraphDecodeErrorZ *NONNULL_PTR orig);
8117 * Creates a new C2Tuple_usizeTransactionZ from the contained elements.
8119 struct LDKC2Tuple_usizeTransactionZ C2Tuple_usizeTransactionZ_new(uintptr_t a, struct LDKTransaction b);
8122 * Frees any resources used by the C2Tuple_usizeTransactionZ.
8124 void C2Tuple_usizeTransactionZ_free(struct LDKC2Tuple_usizeTransactionZ _res);
8127 * Frees the buffer pointed to by `data` if `datalen` is non-0.
8129 void CVec_C2Tuple_usizeTransactionZZ_free(struct LDKCVec_C2Tuple_usizeTransactionZZ _res);
8132 * Creates a new CResult_NoneChannelMonitorUpdateErrZ in the success state.
8134 struct LDKCResult_NoneChannelMonitorUpdateErrZ CResult_NoneChannelMonitorUpdateErrZ_ok(void);
8137 * Creates a new CResult_NoneChannelMonitorUpdateErrZ in the error state.
8139 struct LDKCResult_NoneChannelMonitorUpdateErrZ CResult_NoneChannelMonitorUpdateErrZ_err(enum LDKChannelMonitorUpdateErr e);
8142 * Frees any resources used by the CResult_NoneChannelMonitorUpdateErrZ.
8144 void CResult_NoneChannelMonitorUpdateErrZ_free(struct LDKCResult_NoneChannelMonitorUpdateErrZ _res);
8147 * Creates a new CResult_NoneChannelMonitorUpdateErrZ which has the same data as `orig`
8148 * but with all dynamically-allocated buffers duplicated in new buffers.
8150 struct LDKCResult_NoneChannelMonitorUpdateErrZ CResult_NoneChannelMonitorUpdateErrZ_clone(const struct LDKCResult_NoneChannelMonitorUpdateErrZ *NONNULL_PTR orig);
8153 * Frees the buffer pointed to by `data` if `datalen` is non-0.
8155 void CVec_MonitorEventZ_free(struct LDKCVec_MonitorEventZ _res);
8158 * Frees the buffer pointed to by `data` if `datalen` is non-0.
8160 void CVec_EventZ_free(struct LDKCVec_EventZ _res);
8163 * Creates a new CResult_OutPointDecodeErrorZ in the success state.
8165 struct LDKCResult_OutPointDecodeErrorZ CResult_OutPointDecodeErrorZ_ok(struct LDKOutPoint o);
8168 * Creates a new CResult_OutPointDecodeErrorZ in the error state.
8170 struct LDKCResult_OutPointDecodeErrorZ CResult_OutPointDecodeErrorZ_err(struct LDKDecodeError e);
8173 * Frees any resources used by the CResult_OutPointDecodeErrorZ.
8175 void CResult_OutPointDecodeErrorZ_free(struct LDKCResult_OutPointDecodeErrorZ _res);
8178 * Creates a new CResult_OutPointDecodeErrorZ which has the same data as `orig`
8179 * but with all dynamically-allocated buffers duplicated in new buffers.
8181 struct LDKCResult_OutPointDecodeErrorZ CResult_OutPointDecodeErrorZ_clone(const struct LDKCResult_OutPointDecodeErrorZ *NONNULL_PTR orig);
8184 * Creates a new CResult_ChannelMonitorUpdateDecodeErrorZ in the success state.
8186 struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ CResult_ChannelMonitorUpdateDecodeErrorZ_ok(struct LDKChannelMonitorUpdate o);
8189 * Creates a new CResult_ChannelMonitorUpdateDecodeErrorZ in the error state.
8191 struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ CResult_ChannelMonitorUpdateDecodeErrorZ_err(struct LDKDecodeError e);
8194 * Frees any resources used by the CResult_ChannelMonitorUpdateDecodeErrorZ.
8196 void CResult_ChannelMonitorUpdateDecodeErrorZ_free(struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ _res);
8199 * Creates a new CResult_ChannelMonitorUpdateDecodeErrorZ which has the same data as `orig`
8200 * but with all dynamically-allocated buffers duplicated in new buffers.
8202 struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ CResult_ChannelMonitorUpdateDecodeErrorZ_clone(const struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ *NONNULL_PTR orig);
8205 * Creates a new CResult_HTLCUpdateDecodeErrorZ in the success state.
8207 struct LDKCResult_HTLCUpdateDecodeErrorZ CResult_HTLCUpdateDecodeErrorZ_ok(struct LDKHTLCUpdate o);
8210 * Creates a new CResult_HTLCUpdateDecodeErrorZ in the error state.
8212 struct LDKCResult_HTLCUpdateDecodeErrorZ CResult_HTLCUpdateDecodeErrorZ_err(struct LDKDecodeError e);
8215 * Frees any resources used by the CResult_HTLCUpdateDecodeErrorZ.
8217 void CResult_HTLCUpdateDecodeErrorZ_free(struct LDKCResult_HTLCUpdateDecodeErrorZ _res);
8220 * Creates a new CResult_HTLCUpdateDecodeErrorZ which has the same data as `orig`
8221 * but with all dynamically-allocated buffers duplicated in new buffers.
8223 struct LDKCResult_HTLCUpdateDecodeErrorZ CResult_HTLCUpdateDecodeErrorZ_clone(const struct LDKCResult_HTLCUpdateDecodeErrorZ *NONNULL_PTR orig);
8226 * Creates a new CResult_NoneMonitorUpdateErrorZ in the success state.
8228 struct LDKCResult_NoneMonitorUpdateErrorZ CResult_NoneMonitorUpdateErrorZ_ok(void);
8231 * Creates a new CResult_NoneMonitorUpdateErrorZ in the error state.
8233 struct LDKCResult_NoneMonitorUpdateErrorZ CResult_NoneMonitorUpdateErrorZ_err(struct LDKMonitorUpdateError e);
8236 * Frees any resources used by the CResult_NoneMonitorUpdateErrorZ.
8238 void CResult_NoneMonitorUpdateErrorZ_free(struct LDKCResult_NoneMonitorUpdateErrorZ _res);
8241 * Creates a new CResult_NoneMonitorUpdateErrorZ which has the same data as `orig`
8242 * but with all dynamically-allocated buffers duplicated in new buffers.
8244 struct LDKCResult_NoneMonitorUpdateErrorZ CResult_NoneMonitorUpdateErrorZ_clone(const struct LDKCResult_NoneMonitorUpdateErrorZ *NONNULL_PTR orig);
8247 * Creates a new tuple which has the same data as `orig`
8248 * but with all dynamically-allocated buffers duplicated in new buffers.
8250 struct LDKC2Tuple_OutPointScriptZ C2Tuple_OutPointScriptZ_clone(const struct LDKC2Tuple_OutPointScriptZ *NONNULL_PTR orig);
8253 * Creates a new C2Tuple_OutPointScriptZ from the contained elements.
8255 struct LDKC2Tuple_OutPointScriptZ C2Tuple_OutPointScriptZ_new(struct LDKOutPoint a, struct LDKCVec_u8Z b);
8258 * Frees any resources used by the C2Tuple_OutPointScriptZ.
8260 void C2Tuple_OutPointScriptZ_free(struct LDKC2Tuple_OutPointScriptZ _res);
8263 * Creates a new tuple which has the same data as `orig`
8264 * but with all dynamically-allocated buffers duplicated in new buffers.
8266 struct LDKC2Tuple_u32ScriptZ C2Tuple_u32ScriptZ_clone(const struct LDKC2Tuple_u32ScriptZ *NONNULL_PTR orig);
8269 * Creates a new C2Tuple_u32ScriptZ from the contained elements.
8271 struct LDKC2Tuple_u32ScriptZ C2Tuple_u32ScriptZ_new(uint32_t a, struct LDKCVec_u8Z b);
8274 * Frees any resources used by the C2Tuple_u32ScriptZ.
8276 void C2Tuple_u32ScriptZ_free(struct LDKC2Tuple_u32ScriptZ _res);
8279 * Frees the buffer pointed to by `data` if `datalen` is non-0.
8281 void CVec_C2Tuple_u32ScriptZZ_free(struct LDKCVec_C2Tuple_u32ScriptZZ _res);
8284 * Creates a new C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ from the contained elements.
8286 struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ_new(struct LDKThirtyTwoBytes a, struct LDKCVec_C2Tuple_u32ScriptZZ b);
8289 * Frees any resources used by the C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ.
8291 void C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ_free(struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ _res);
8294 * Frees the buffer pointed to by `data` if `datalen` is non-0.
8296 void CVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ_free(struct LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ _res);
8299 * Frees the buffer pointed to by `data` if `datalen` is non-0.
8301 void CVec_TransactionZ_free(struct LDKCVec_TransactionZ _res);
8304 * Creates a new tuple which has the same data as `orig`
8305 * but with all dynamically-allocated buffers duplicated in new buffers.
8307 struct LDKC2Tuple_u32TxOutZ C2Tuple_u32TxOutZ_clone(const struct LDKC2Tuple_u32TxOutZ *NONNULL_PTR orig);
8310 * Creates a new C2Tuple_u32TxOutZ from the contained elements.
8312 struct LDKC2Tuple_u32TxOutZ C2Tuple_u32TxOutZ_new(uint32_t a, struct LDKTxOut b);
8315 * Frees any resources used by the C2Tuple_u32TxOutZ.
8317 void C2Tuple_u32TxOutZ_free(struct LDKC2Tuple_u32TxOutZ _res);
8320 * Frees the buffer pointed to by `data` if `datalen` is non-0.
8322 void CVec_C2Tuple_u32TxOutZZ_free(struct LDKCVec_C2Tuple_u32TxOutZZ _res);
8325 * Creates a new C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ from the contained elements.
8327 struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ_new(struct LDKThirtyTwoBytes a, struct LDKCVec_C2Tuple_u32TxOutZZ b);
8330 * Frees any resources used by the C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ.
8332 void C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ_free(struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ _res);
8335 * Frees the buffer pointed to by `data` if `datalen` is non-0.
8337 void CVec_C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZZ_free(struct LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZZ _res);
8340 * Creates a new C2Tuple_BlockHashChannelMonitorZ from the contained elements.
8342 struct LDKC2Tuple_BlockHashChannelMonitorZ C2Tuple_BlockHashChannelMonitorZ_new(struct LDKThirtyTwoBytes a, struct LDKChannelMonitor b);
8345 * Frees any resources used by the C2Tuple_BlockHashChannelMonitorZ.
8347 void C2Tuple_BlockHashChannelMonitorZ_free(struct LDKC2Tuple_BlockHashChannelMonitorZ _res);
8350 * Creates a new CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ in the success state.
8352 struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_ok(struct LDKC2Tuple_BlockHashChannelMonitorZ o);
8355 * Creates a new CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ in the error state.
8357 struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_err(struct LDKDecodeError e);
8360 * Frees any resources used by the CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.
8362 void CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_free(struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ _res);
8365 * Frees the buffer pointed to by `data` if `datalen` is non-0.
8367 void CVec_SpendableOutputDescriptorZ_free(struct LDKCVec_SpendableOutputDescriptorZ _res);
8370 * Creates a new CResult_TxOutAccessErrorZ in the success state.
8372 struct LDKCResult_TxOutAccessErrorZ CResult_TxOutAccessErrorZ_ok(struct LDKTxOut o);
8375 * Creates a new CResult_TxOutAccessErrorZ in the error state.
8377 struct LDKCResult_TxOutAccessErrorZ CResult_TxOutAccessErrorZ_err(enum LDKAccessError e);
8380 * Frees any resources used by the CResult_TxOutAccessErrorZ.
8382 void CResult_TxOutAccessErrorZ_free(struct LDKCResult_TxOutAccessErrorZ _res);
8385 * Creates a new CResult_TxOutAccessErrorZ which has the same data as `orig`
8386 * but with all dynamically-allocated buffers duplicated in new buffers.
8388 struct LDKCResult_TxOutAccessErrorZ CResult_TxOutAccessErrorZ_clone(const struct LDKCResult_TxOutAccessErrorZ *NONNULL_PTR orig);
8391 * Constructs a new COption_C2Tuple_usizeTransactionZZ containing a crate::c_types::derived::C2Tuple_usizeTransactionZ
8393 struct LDKCOption_C2Tuple_usizeTransactionZZ COption_C2Tuple_usizeTransactionZZ_some(struct LDKC2Tuple_usizeTransactionZ o);
8396 * Constructs a new COption_C2Tuple_usizeTransactionZZ containing nothing
8398 struct LDKCOption_C2Tuple_usizeTransactionZZ COption_C2Tuple_usizeTransactionZZ_none(void);
8401 * Frees any resources associated with the crate::c_types::derived::C2Tuple_usizeTransactionZ, if we are in the Some state
8403 void COption_C2Tuple_usizeTransactionZZ_free(struct LDKCOption_C2Tuple_usizeTransactionZZ _res);
8406 * Creates a new CResult_NoneAPIErrorZ in the success state.
8408 struct LDKCResult_NoneAPIErrorZ CResult_NoneAPIErrorZ_ok(void);
8411 * Creates a new CResult_NoneAPIErrorZ in the error state.
8413 struct LDKCResult_NoneAPIErrorZ CResult_NoneAPIErrorZ_err(struct LDKAPIError e);
8416 * Frees any resources used by the CResult_NoneAPIErrorZ.
8418 void CResult_NoneAPIErrorZ_free(struct LDKCResult_NoneAPIErrorZ _res);
8421 * Creates a new CResult_NoneAPIErrorZ which has the same data as `orig`
8422 * but with all dynamically-allocated buffers duplicated in new buffers.
8424 struct LDKCResult_NoneAPIErrorZ CResult_NoneAPIErrorZ_clone(const struct LDKCResult_NoneAPIErrorZ *NONNULL_PTR orig);
8427 * Frees the buffer pointed to by `data` if `datalen` is non-0.
8429 void CVec_CResult_NoneAPIErrorZZ_free(struct LDKCVec_CResult_NoneAPIErrorZZ _res);
8432 * Frees the buffer pointed to by `data` if `datalen` is non-0.
8434 void CVec_APIErrorZ_free(struct LDKCVec_APIErrorZ _res);
8437 * Frees the buffer pointed to by `data` if `datalen` is non-0.
8439 void CVec_ChannelDetailsZ_free(struct LDKCVec_ChannelDetailsZ _res);
8442 * Creates a new CResult_NonePaymentSendFailureZ in the success state.
8444 struct LDKCResult_NonePaymentSendFailureZ CResult_NonePaymentSendFailureZ_ok(void);
8447 * Creates a new CResult_NonePaymentSendFailureZ in the error state.
8449 struct LDKCResult_NonePaymentSendFailureZ CResult_NonePaymentSendFailureZ_err(struct LDKPaymentSendFailure e);
8452 * Frees any resources used by the CResult_NonePaymentSendFailureZ.
8454 void CResult_NonePaymentSendFailureZ_free(struct LDKCResult_NonePaymentSendFailureZ _res);
8457 * Creates a new CResult_NonePaymentSendFailureZ which has the same data as `orig`
8458 * but with all dynamically-allocated buffers duplicated in new buffers.
8460 struct LDKCResult_NonePaymentSendFailureZ CResult_NonePaymentSendFailureZ_clone(const struct LDKCResult_NonePaymentSendFailureZ *NONNULL_PTR orig);
8463 * Frees the buffer pointed to by `data` if `datalen` is non-0.
8465 void CVec_ChannelMonitorZ_free(struct LDKCVec_ChannelMonitorZ _res);
8468 * Creates a new C2Tuple_BlockHashChannelManagerZ from the contained elements.
8470 struct LDKC2Tuple_BlockHashChannelManagerZ C2Tuple_BlockHashChannelManagerZ_new(struct LDKThirtyTwoBytes a, struct LDKChannelManager b);
8473 * Frees any resources used by the C2Tuple_BlockHashChannelManagerZ.
8475 void C2Tuple_BlockHashChannelManagerZ_free(struct LDKC2Tuple_BlockHashChannelManagerZ _res);
8478 * Creates a new CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ in the success state.
8480 struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_ok(struct LDKC2Tuple_BlockHashChannelManagerZ o);
8483 * Creates a new CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ in the error state.
8485 struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_err(struct LDKDecodeError e);
8488 * Frees any resources used by the CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.
8490 void CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_free(struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ _res);
8493 * Creates a new CResult_SpendableOutputDescriptorDecodeErrorZ in the success state.
8495 struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ CResult_SpendableOutputDescriptorDecodeErrorZ_ok(struct LDKSpendableOutputDescriptor o);
8498 * Creates a new CResult_SpendableOutputDescriptorDecodeErrorZ in the error state.
8500 struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ CResult_SpendableOutputDescriptorDecodeErrorZ_err(struct LDKDecodeError e);
8503 * Frees any resources used by the CResult_SpendableOutputDescriptorDecodeErrorZ.
8505 void CResult_SpendableOutputDescriptorDecodeErrorZ_free(struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ _res);
8508 * Creates a new CResult_SpendableOutputDescriptorDecodeErrorZ which has the same data as `orig`
8509 * but with all dynamically-allocated buffers duplicated in new buffers.
8511 struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ CResult_SpendableOutputDescriptorDecodeErrorZ_clone(const struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ *NONNULL_PTR orig);
8514 * Creates a new tuple which has the same data as `orig`
8515 * but with all dynamically-allocated buffers duplicated in new buffers.
8517 struct LDKC2Tuple_SignatureCVec_SignatureZZ C2Tuple_SignatureCVec_SignatureZZ_clone(const struct LDKC2Tuple_SignatureCVec_SignatureZZ *NONNULL_PTR orig);
8520 * Creates a new C2Tuple_SignatureCVec_SignatureZZ from the contained elements.
8522 struct LDKC2Tuple_SignatureCVec_SignatureZZ C2Tuple_SignatureCVec_SignatureZZ_new(struct LDKSignature a, struct LDKCVec_SignatureZ b);
8525 * Frees any resources used by the C2Tuple_SignatureCVec_SignatureZZ.
8527 void C2Tuple_SignatureCVec_SignatureZZ_free(struct LDKC2Tuple_SignatureCVec_SignatureZZ _res);
8530 * Creates a new CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ in the success state.
8532 struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ_ok(struct LDKC2Tuple_SignatureCVec_SignatureZZ o);
8535 * Creates a new CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ in the error state.
8537 struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ_err(void);
8540 * Frees any resources used by the CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ.
8542 void CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ_free(struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ _res);
8545 * Creates a new CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ which has the same data as `orig`
8546 * but with all dynamically-allocated buffers duplicated in new buffers.
8548 struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ_clone(const struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ *NONNULL_PTR orig);
8551 * Creates a new CResult_SignatureNoneZ in the success state.
8553 struct LDKCResult_SignatureNoneZ CResult_SignatureNoneZ_ok(struct LDKSignature o);
8556 * Creates a new CResult_SignatureNoneZ in the error state.
8558 struct LDKCResult_SignatureNoneZ CResult_SignatureNoneZ_err(void);
8561 * Frees any resources used by the CResult_SignatureNoneZ.
8563 void CResult_SignatureNoneZ_free(struct LDKCResult_SignatureNoneZ _res);
8566 * Creates a new CResult_SignatureNoneZ which has the same data as `orig`
8567 * but with all dynamically-allocated buffers duplicated in new buffers.
8569 struct LDKCResult_SignatureNoneZ CResult_SignatureNoneZ_clone(const struct LDKCResult_SignatureNoneZ *NONNULL_PTR orig);
8572 * Creates a new CResult_SignDecodeErrorZ in the success state.
8574 struct LDKCResult_SignDecodeErrorZ CResult_SignDecodeErrorZ_ok(struct LDKSign o);
8577 * Creates a new CResult_SignDecodeErrorZ in the error state.
8579 struct LDKCResult_SignDecodeErrorZ CResult_SignDecodeErrorZ_err(struct LDKDecodeError e);
8582 * Frees any resources used by the CResult_SignDecodeErrorZ.
8584 void CResult_SignDecodeErrorZ_free(struct LDKCResult_SignDecodeErrorZ _res);
8587 * Creates a new CResult_SignDecodeErrorZ which has the same data as `orig`
8588 * but with all dynamically-allocated buffers duplicated in new buffers.
8590 struct LDKCResult_SignDecodeErrorZ CResult_SignDecodeErrorZ_clone(const struct LDKCResult_SignDecodeErrorZ *NONNULL_PTR orig);
8593 * Frees the buffer pointed to by `data` if `datalen` is non-0.
8595 void CVec_CVec_u8ZZ_free(struct LDKCVec_CVec_u8ZZ _res);
8598 * Creates a new CResult_CVec_CVec_u8ZZNoneZ in the success state.
8600 struct LDKCResult_CVec_CVec_u8ZZNoneZ CResult_CVec_CVec_u8ZZNoneZ_ok(struct LDKCVec_CVec_u8ZZ o);
8603 * Creates a new CResult_CVec_CVec_u8ZZNoneZ in the error state.
8605 struct LDKCResult_CVec_CVec_u8ZZNoneZ CResult_CVec_CVec_u8ZZNoneZ_err(void);
8608 * Frees any resources used by the CResult_CVec_CVec_u8ZZNoneZ.
8610 void CResult_CVec_CVec_u8ZZNoneZ_free(struct LDKCResult_CVec_CVec_u8ZZNoneZ _res);
8613 * Creates a new CResult_CVec_CVec_u8ZZNoneZ which has the same data as `orig`
8614 * but with all dynamically-allocated buffers duplicated in new buffers.
8616 struct LDKCResult_CVec_CVec_u8ZZNoneZ CResult_CVec_CVec_u8ZZNoneZ_clone(const struct LDKCResult_CVec_CVec_u8ZZNoneZ *NONNULL_PTR orig);
8619 * Creates a new CResult_InMemorySignerDecodeErrorZ in the success state.
8621 struct LDKCResult_InMemorySignerDecodeErrorZ CResult_InMemorySignerDecodeErrorZ_ok(struct LDKInMemorySigner o);
8624 * Creates a new CResult_InMemorySignerDecodeErrorZ in the error state.
8626 struct LDKCResult_InMemorySignerDecodeErrorZ CResult_InMemorySignerDecodeErrorZ_err(struct LDKDecodeError e);
8629 * Frees any resources used by the CResult_InMemorySignerDecodeErrorZ.
8631 void CResult_InMemorySignerDecodeErrorZ_free(struct LDKCResult_InMemorySignerDecodeErrorZ _res);
8634 * Creates a new CResult_InMemorySignerDecodeErrorZ which has the same data as `orig`
8635 * but with all dynamically-allocated buffers duplicated in new buffers.
8637 struct LDKCResult_InMemorySignerDecodeErrorZ CResult_InMemorySignerDecodeErrorZ_clone(const struct LDKCResult_InMemorySignerDecodeErrorZ *NONNULL_PTR orig);
8640 * Frees the buffer pointed to by `data` if `datalen` is non-0.
8642 void CVec_TxOutZ_free(struct LDKCVec_TxOutZ _res);
8645 * Creates a new CResult_TransactionNoneZ in the success state.
8647 struct LDKCResult_TransactionNoneZ CResult_TransactionNoneZ_ok(struct LDKTransaction o);
8650 * Creates a new CResult_TransactionNoneZ in the error state.
8652 struct LDKCResult_TransactionNoneZ CResult_TransactionNoneZ_err(void);
8655 * Frees any resources used by the CResult_TransactionNoneZ.
8657 void CResult_TransactionNoneZ_free(struct LDKCResult_TransactionNoneZ _res);
8660 * Frees the buffer pointed to by `data` if `datalen` is non-0.
8662 void CVec_RouteHopZ_free(struct LDKCVec_RouteHopZ _res);
8665 * Frees the buffer pointed to by `data` if `datalen` is non-0.
8667 void CVec_CVec_RouteHopZZ_free(struct LDKCVec_CVec_RouteHopZZ _res);
8670 * Creates a new CResult_RouteDecodeErrorZ in the success state.
8672 struct LDKCResult_RouteDecodeErrorZ CResult_RouteDecodeErrorZ_ok(struct LDKRoute o);
8675 * Creates a new CResult_RouteDecodeErrorZ in the error state.
8677 struct LDKCResult_RouteDecodeErrorZ CResult_RouteDecodeErrorZ_err(struct LDKDecodeError e);
8680 * Frees any resources used by the CResult_RouteDecodeErrorZ.
8682 void CResult_RouteDecodeErrorZ_free(struct LDKCResult_RouteDecodeErrorZ _res);
8685 * Creates a new CResult_RouteDecodeErrorZ which has the same data as `orig`
8686 * but with all dynamically-allocated buffers duplicated in new buffers.
8688 struct LDKCResult_RouteDecodeErrorZ CResult_RouteDecodeErrorZ_clone(const struct LDKCResult_RouteDecodeErrorZ *NONNULL_PTR orig);
8691 * Frees the buffer pointed to by `data` if `datalen` is non-0.
8693 void CVec_RouteHintZ_free(struct LDKCVec_RouteHintZ _res);
8696 * Creates a new CResult_RouteLightningErrorZ in the success state.
8698 struct LDKCResult_RouteLightningErrorZ CResult_RouteLightningErrorZ_ok(struct LDKRoute o);
8701 * Creates a new CResult_RouteLightningErrorZ in the error state.
8703 struct LDKCResult_RouteLightningErrorZ CResult_RouteLightningErrorZ_err(struct LDKLightningError e);
8706 * Frees any resources used by the CResult_RouteLightningErrorZ.
8708 void CResult_RouteLightningErrorZ_free(struct LDKCResult_RouteLightningErrorZ _res);
8711 * Creates a new CResult_RouteLightningErrorZ which has the same data as `orig`
8712 * but with all dynamically-allocated buffers duplicated in new buffers.
8714 struct LDKCResult_RouteLightningErrorZ CResult_RouteLightningErrorZ_clone(const struct LDKCResult_RouteLightningErrorZ *NONNULL_PTR orig);
8717 * Creates a new CResult_NetAddressu8Z in the success state.
8719 struct LDKCResult_NetAddressu8Z CResult_NetAddressu8Z_ok(struct LDKNetAddress o);
8722 * Creates a new CResult_NetAddressu8Z in the error state.
8724 struct LDKCResult_NetAddressu8Z CResult_NetAddressu8Z_err(uint8_t e);
8727 * Frees any resources used by the CResult_NetAddressu8Z.
8729 void CResult_NetAddressu8Z_free(struct LDKCResult_NetAddressu8Z _res);
8732 * Creates a new CResult_NetAddressu8Z which has the same data as `orig`
8733 * but with all dynamically-allocated buffers duplicated in new buffers.
8735 struct LDKCResult_NetAddressu8Z CResult_NetAddressu8Z_clone(const struct LDKCResult_NetAddressu8Z *NONNULL_PTR orig);
8738 * Creates a new CResult_CResult_NetAddressu8ZDecodeErrorZ in the success state.
8740 struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ CResult_CResult_NetAddressu8ZDecodeErrorZ_ok(struct LDKCResult_NetAddressu8Z o);
8743 * Creates a new CResult_CResult_NetAddressu8ZDecodeErrorZ in the error state.
8745 struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ CResult_CResult_NetAddressu8ZDecodeErrorZ_err(struct LDKDecodeError e);
8748 * Frees any resources used by the CResult_CResult_NetAddressu8ZDecodeErrorZ.
8750 void CResult_CResult_NetAddressu8ZDecodeErrorZ_free(struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ _res);
8753 * Creates a new CResult_CResult_NetAddressu8ZDecodeErrorZ which has the same data as `orig`
8754 * but with all dynamically-allocated buffers duplicated in new buffers.
8756 struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ CResult_CResult_NetAddressu8ZDecodeErrorZ_clone(const struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ *NONNULL_PTR orig);
8759 * Frees the buffer pointed to by `data` if `datalen` is non-0.
8761 void CVec_UpdateAddHTLCZ_free(struct LDKCVec_UpdateAddHTLCZ _res);
8764 * Frees the buffer pointed to by `data` if `datalen` is non-0.
8766 void CVec_UpdateFulfillHTLCZ_free(struct LDKCVec_UpdateFulfillHTLCZ _res);
8769 * Frees the buffer pointed to by `data` if `datalen` is non-0.
8771 void CVec_UpdateFailHTLCZ_free(struct LDKCVec_UpdateFailHTLCZ _res);
8774 * Frees the buffer pointed to by `data` if `datalen` is non-0.
8776 void CVec_UpdateFailMalformedHTLCZ_free(struct LDKCVec_UpdateFailMalformedHTLCZ _res);
8779 * Creates a new CResult_AcceptChannelDecodeErrorZ in the success state.
8781 struct LDKCResult_AcceptChannelDecodeErrorZ CResult_AcceptChannelDecodeErrorZ_ok(struct LDKAcceptChannel o);
8784 * Creates a new CResult_AcceptChannelDecodeErrorZ in the error state.
8786 struct LDKCResult_AcceptChannelDecodeErrorZ CResult_AcceptChannelDecodeErrorZ_err(struct LDKDecodeError e);
8789 * Frees any resources used by the CResult_AcceptChannelDecodeErrorZ.
8791 void CResult_AcceptChannelDecodeErrorZ_free(struct LDKCResult_AcceptChannelDecodeErrorZ _res);
8794 * Creates a new CResult_AcceptChannelDecodeErrorZ which has the same data as `orig`
8795 * but with all dynamically-allocated buffers duplicated in new buffers.
8797 struct LDKCResult_AcceptChannelDecodeErrorZ CResult_AcceptChannelDecodeErrorZ_clone(const struct LDKCResult_AcceptChannelDecodeErrorZ *NONNULL_PTR orig);
8800 * Creates a new CResult_AnnouncementSignaturesDecodeErrorZ in the success state.
8802 struct LDKCResult_AnnouncementSignaturesDecodeErrorZ CResult_AnnouncementSignaturesDecodeErrorZ_ok(struct LDKAnnouncementSignatures o);
8805 * Creates a new CResult_AnnouncementSignaturesDecodeErrorZ in the error state.
8807 struct LDKCResult_AnnouncementSignaturesDecodeErrorZ CResult_AnnouncementSignaturesDecodeErrorZ_err(struct LDKDecodeError e);
8810 * Frees any resources used by the CResult_AnnouncementSignaturesDecodeErrorZ.
8812 void CResult_AnnouncementSignaturesDecodeErrorZ_free(struct LDKCResult_AnnouncementSignaturesDecodeErrorZ _res);
8815 * Creates a new CResult_AnnouncementSignaturesDecodeErrorZ which has the same data as `orig`
8816 * but with all dynamically-allocated buffers duplicated in new buffers.
8818 struct LDKCResult_AnnouncementSignaturesDecodeErrorZ CResult_AnnouncementSignaturesDecodeErrorZ_clone(const struct LDKCResult_AnnouncementSignaturesDecodeErrorZ *NONNULL_PTR orig);
8821 * Creates a new CResult_ChannelReestablishDecodeErrorZ in the success state.
8823 struct LDKCResult_ChannelReestablishDecodeErrorZ CResult_ChannelReestablishDecodeErrorZ_ok(struct LDKChannelReestablish o);
8826 * Creates a new CResult_ChannelReestablishDecodeErrorZ in the error state.
8828 struct LDKCResult_ChannelReestablishDecodeErrorZ CResult_ChannelReestablishDecodeErrorZ_err(struct LDKDecodeError e);
8831 * Frees any resources used by the CResult_ChannelReestablishDecodeErrorZ.
8833 void CResult_ChannelReestablishDecodeErrorZ_free(struct LDKCResult_ChannelReestablishDecodeErrorZ _res);
8836 * Creates a new CResult_ChannelReestablishDecodeErrorZ which has the same data as `orig`
8837 * but with all dynamically-allocated buffers duplicated in new buffers.
8839 struct LDKCResult_ChannelReestablishDecodeErrorZ CResult_ChannelReestablishDecodeErrorZ_clone(const struct LDKCResult_ChannelReestablishDecodeErrorZ *NONNULL_PTR orig);
8842 * Creates a new CResult_ClosingSignedDecodeErrorZ in the success state.
8844 struct LDKCResult_ClosingSignedDecodeErrorZ CResult_ClosingSignedDecodeErrorZ_ok(struct LDKClosingSigned o);
8847 * Creates a new CResult_ClosingSignedDecodeErrorZ in the error state.
8849 struct LDKCResult_ClosingSignedDecodeErrorZ CResult_ClosingSignedDecodeErrorZ_err(struct LDKDecodeError e);
8852 * Frees any resources used by the CResult_ClosingSignedDecodeErrorZ.
8854 void CResult_ClosingSignedDecodeErrorZ_free(struct LDKCResult_ClosingSignedDecodeErrorZ _res);
8857 * Creates a new CResult_ClosingSignedDecodeErrorZ which has the same data as `orig`
8858 * but with all dynamically-allocated buffers duplicated in new buffers.
8860 struct LDKCResult_ClosingSignedDecodeErrorZ CResult_ClosingSignedDecodeErrorZ_clone(const struct LDKCResult_ClosingSignedDecodeErrorZ *NONNULL_PTR orig);
8863 * Creates a new CResult_CommitmentSignedDecodeErrorZ in the success state.
8865 struct LDKCResult_CommitmentSignedDecodeErrorZ CResult_CommitmentSignedDecodeErrorZ_ok(struct LDKCommitmentSigned o);
8868 * Creates a new CResult_CommitmentSignedDecodeErrorZ in the error state.
8870 struct LDKCResult_CommitmentSignedDecodeErrorZ CResult_CommitmentSignedDecodeErrorZ_err(struct LDKDecodeError e);
8873 * Frees any resources used by the CResult_CommitmentSignedDecodeErrorZ.
8875 void CResult_CommitmentSignedDecodeErrorZ_free(struct LDKCResult_CommitmentSignedDecodeErrorZ _res);
8878 * Creates a new CResult_CommitmentSignedDecodeErrorZ which has the same data as `orig`
8879 * but with all dynamically-allocated buffers duplicated in new buffers.
8881 struct LDKCResult_CommitmentSignedDecodeErrorZ CResult_CommitmentSignedDecodeErrorZ_clone(const struct LDKCResult_CommitmentSignedDecodeErrorZ *NONNULL_PTR orig);
8884 * Creates a new CResult_FundingCreatedDecodeErrorZ in the success state.
8886 struct LDKCResult_FundingCreatedDecodeErrorZ CResult_FundingCreatedDecodeErrorZ_ok(struct LDKFundingCreated o);
8889 * Creates a new CResult_FundingCreatedDecodeErrorZ in the error state.
8891 struct LDKCResult_FundingCreatedDecodeErrorZ CResult_FundingCreatedDecodeErrorZ_err(struct LDKDecodeError e);
8894 * Frees any resources used by the CResult_FundingCreatedDecodeErrorZ.
8896 void CResult_FundingCreatedDecodeErrorZ_free(struct LDKCResult_FundingCreatedDecodeErrorZ _res);
8899 * Creates a new CResult_FundingCreatedDecodeErrorZ which has the same data as `orig`
8900 * but with all dynamically-allocated buffers duplicated in new buffers.
8902 struct LDKCResult_FundingCreatedDecodeErrorZ CResult_FundingCreatedDecodeErrorZ_clone(const struct LDKCResult_FundingCreatedDecodeErrorZ *NONNULL_PTR orig);
8905 * Creates a new CResult_FundingSignedDecodeErrorZ in the success state.
8907 struct LDKCResult_FundingSignedDecodeErrorZ CResult_FundingSignedDecodeErrorZ_ok(struct LDKFundingSigned o);
8910 * Creates a new CResult_FundingSignedDecodeErrorZ in the error state.
8912 struct LDKCResult_FundingSignedDecodeErrorZ CResult_FundingSignedDecodeErrorZ_err(struct LDKDecodeError e);
8915 * Frees any resources used by the CResult_FundingSignedDecodeErrorZ.
8917 void CResult_FundingSignedDecodeErrorZ_free(struct LDKCResult_FundingSignedDecodeErrorZ _res);
8920 * Creates a new CResult_FundingSignedDecodeErrorZ which has the same data as `orig`
8921 * but with all dynamically-allocated buffers duplicated in new buffers.
8923 struct LDKCResult_FundingSignedDecodeErrorZ CResult_FundingSignedDecodeErrorZ_clone(const struct LDKCResult_FundingSignedDecodeErrorZ *NONNULL_PTR orig);
8926 * Creates a new CResult_FundingLockedDecodeErrorZ in the success state.
8928 struct LDKCResult_FundingLockedDecodeErrorZ CResult_FundingLockedDecodeErrorZ_ok(struct LDKFundingLocked o);
8931 * Creates a new CResult_FundingLockedDecodeErrorZ in the error state.
8933 struct LDKCResult_FundingLockedDecodeErrorZ CResult_FundingLockedDecodeErrorZ_err(struct LDKDecodeError e);
8936 * Frees any resources used by the CResult_FundingLockedDecodeErrorZ.
8938 void CResult_FundingLockedDecodeErrorZ_free(struct LDKCResult_FundingLockedDecodeErrorZ _res);
8941 * Creates a new CResult_FundingLockedDecodeErrorZ which has the same data as `orig`
8942 * but with all dynamically-allocated buffers duplicated in new buffers.
8944 struct LDKCResult_FundingLockedDecodeErrorZ CResult_FundingLockedDecodeErrorZ_clone(const struct LDKCResult_FundingLockedDecodeErrorZ *NONNULL_PTR orig);
8947 * Creates a new CResult_InitDecodeErrorZ in the success state.
8949 struct LDKCResult_InitDecodeErrorZ CResult_InitDecodeErrorZ_ok(struct LDKInit o);
8952 * Creates a new CResult_InitDecodeErrorZ in the error state.
8954 struct LDKCResult_InitDecodeErrorZ CResult_InitDecodeErrorZ_err(struct LDKDecodeError e);
8957 * Frees any resources used by the CResult_InitDecodeErrorZ.
8959 void CResult_InitDecodeErrorZ_free(struct LDKCResult_InitDecodeErrorZ _res);
8962 * Creates a new CResult_InitDecodeErrorZ which has the same data as `orig`
8963 * but with all dynamically-allocated buffers duplicated in new buffers.
8965 struct LDKCResult_InitDecodeErrorZ CResult_InitDecodeErrorZ_clone(const struct LDKCResult_InitDecodeErrorZ *NONNULL_PTR orig);
8968 * Creates a new CResult_OpenChannelDecodeErrorZ in the success state.
8970 struct LDKCResult_OpenChannelDecodeErrorZ CResult_OpenChannelDecodeErrorZ_ok(struct LDKOpenChannel o);
8973 * Creates a new CResult_OpenChannelDecodeErrorZ in the error state.
8975 struct LDKCResult_OpenChannelDecodeErrorZ CResult_OpenChannelDecodeErrorZ_err(struct LDKDecodeError e);
8978 * Frees any resources used by the CResult_OpenChannelDecodeErrorZ.
8980 void CResult_OpenChannelDecodeErrorZ_free(struct LDKCResult_OpenChannelDecodeErrorZ _res);
8983 * Creates a new CResult_OpenChannelDecodeErrorZ which has the same data as `orig`
8984 * but with all dynamically-allocated buffers duplicated in new buffers.
8986 struct LDKCResult_OpenChannelDecodeErrorZ CResult_OpenChannelDecodeErrorZ_clone(const struct LDKCResult_OpenChannelDecodeErrorZ *NONNULL_PTR orig);
8989 * Creates a new CResult_RevokeAndACKDecodeErrorZ in the success state.
8991 struct LDKCResult_RevokeAndACKDecodeErrorZ CResult_RevokeAndACKDecodeErrorZ_ok(struct LDKRevokeAndACK o);
8994 * Creates a new CResult_RevokeAndACKDecodeErrorZ in the error state.
8996 struct LDKCResult_RevokeAndACKDecodeErrorZ CResult_RevokeAndACKDecodeErrorZ_err(struct LDKDecodeError e);
8999 * Frees any resources used by the CResult_RevokeAndACKDecodeErrorZ.
9001 void CResult_RevokeAndACKDecodeErrorZ_free(struct LDKCResult_RevokeAndACKDecodeErrorZ _res);
9004 * Creates a new CResult_RevokeAndACKDecodeErrorZ which has the same data as `orig`
9005 * but with all dynamically-allocated buffers duplicated in new buffers.
9007 struct LDKCResult_RevokeAndACKDecodeErrorZ CResult_RevokeAndACKDecodeErrorZ_clone(const struct LDKCResult_RevokeAndACKDecodeErrorZ *NONNULL_PTR orig);
9010 * Creates a new CResult_ShutdownDecodeErrorZ in the success state.
9012 struct LDKCResult_ShutdownDecodeErrorZ CResult_ShutdownDecodeErrorZ_ok(struct LDKShutdown o);
9015 * Creates a new CResult_ShutdownDecodeErrorZ in the error state.
9017 struct LDKCResult_ShutdownDecodeErrorZ CResult_ShutdownDecodeErrorZ_err(struct LDKDecodeError e);
9020 * Frees any resources used by the CResult_ShutdownDecodeErrorZ.
9022 void CResult_ShutdownDecodeErrorZ_free(struct LDKCResult_ShutdownDecodeErrorZ _res);
9025 * Creates a new CResult_ShutdownDecodeErrorZ which has the same data as `orig`
9026 * but with all dynamically-allocated buffers duplicated in new buffers.
9028 struct LDKCResult_ShutdownDecodeErrorZ CResult_ShutdownDecodeErrorZ_clone(const struct LDKCResult_ShutdownDecodeErrorZ *NONNULL_PTR orig);
9031 * Creates a new CResult_UpdateFailHTLCDecodeErrorZ in the success state.
9033 struct LDKCResult_UpdateFailHTLCDecodeErrorZ CResult_UpdateFailHTLCDecodeErrorZ_ok(struct LDKUpdateFailHTLC o);
9036 * Creates a new CResult_UpdateFailHTLCDecodeErrorZ in the error state.
9038 struct LDKCResult_UpdateFailHTLCDecodeErrorZ CResult_UpdateFailHTLCDecodeErrorZ_err(struct LDKDecodeError e);
9041 * Frees any resources used by the CResult_UpdateFailHTLCDecodeErrorZ.
9043 void CResult_UpdateFailHTLCDecodeErrorZ_free(struct LDKCResult_UpdateFailHTLCDecodeErrorZ _res);
9046 * Creates a new CResult_UpdateFailHTLCDecodeErrorZ which has the same data as `orig`
9047 * but with all dynamically-allocated buffers duplicated in new buffers.
9049 struct LDKCResult_UpdateFailHTLCDecodeErrorZ CResult_UpdateFailHTLCDecodeErrorZ_clone(const struct LDKCResult_UpdateFailHTLCDecodeErrorZ *NONNULL_PTR orig);
9052 * Creates a new CResult_UpdateFailMalformedHTLCDecodeErrorZ in the success state.
9054 struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ CResult_UpdateFailMalformedHTLCDecodeErrorZ_ok(struct LDKUpdateFailMalformedHTLC o);
9057 * Creates a new CResult_UpdateFailMalformedHTLCDecodeErrorZ in the error state.
9059 struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ CResult_UpdateFailMalformedHTLCDecodeErrorZ_err(struct LDKDecodeError e);
9062 * Frees any resources used by the CResult_UpdateFailMalformedHTLCDecodeErrorZ.
9064 void CResult_UpdateFailMalformedHTLCDecodeErrorZ_free(struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ _res);
9067 * Creates a new CResult_UpdateFailMalformedHTLCDecodeErrorZ which has the same data as `orig`
9068 * but with all dynamically-allocated buffers duplicated in new buffers.
9070 struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ CResult_UpdateFailMalformedHTLCDecodeErrorZ_clone(const struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ *NONNULL_PTR orig);
9073 * Creates a new CResult_UpdateFeeDecodeErrorZ in the success state.
9075 struct LDKCResult_UpdateFeeDecodeErrorZ CResult_UpdateFeeDecodeErrorZ_ok(struct LDKUpdateFee o);
9078 * Creates a new CResult_UpdateFeeDecodeErrorZ in the error state.
9080 struct LDKCResult_UpdateFeeDecodeErrorZ CResult_UpdateFeeDecodeErrorZ_err(struct LDKDecodeError e);
9083 * Frees any resources used by the CResult_UpdateFeeDecodeErrorZ.
9085 void CResult_UpdateFeeDecodeErrorZ_free(struct LDKCResult_UpdateFeeDecodeErrorZ _res);
9088 * Creates a new CResult_UpdateFeeDecodeErrorZ which has the same data as `orig`
9089 * but with all dynamically-allocated buffers duplicated in new buffers.
9091 struct LDKCResult_UpdateFeeDecodeErrorZ CResult_UpdateFeeDecodeErrorZ_clone(const struct LDKCResult_UpdateFeeDecodeErrorZ *NONNULL_PTR orig);
9094 * Creates a new CResult_UpdateFulfillHTLCDecodeErrorZ in the success state.
9096 struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ CResult_UpdateFulfillHTLCDecodeErrorZ_ok(struct LDKUpdateFulfillHTLC o);
9099 * Creates a new CResult_UpdateFulfillHTLCDecodeErrorZ in the error state.
9101 struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ CResult_UpdateFulfillHTLCDecodeErrorZ_err(struct LDKDecodeError e);
9104 * Frees any resources used by the CResult_UpdateFulfillHTLCDecodeErrorZ.
9106 void CResult_UpdateFulfillHTLCDecodeErrorZ_free(struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ _res);
9109 * Creates a new CResult_UpdateFulfillHTLCDecodeErrorZ which has the same data as `orig`
9110 * but with all dynamically-allocated buffers duplicated in new buffers.
9112 struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ CResult_UpdateFulfillHTLCDecodeErrorZ_clone(const struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ *NONNULL_PTR orig);
9115 * Creates a new CResult_UpdateAddHTLCDecodeErrorZ in the success state.
9117 struct LDKCResult_UpdateAddHTLCDecodeErrorZ CResult_UpdateAddHTLCDecodeErrorZ_ok(struct LDKUpdateAddHTLC o);
9120 * Creates a new CResult_UpdateAddHTLCDecodeErrorZ in the error state.
9122 struct LDKCResult_UpdateAddHTLCDecodeErrorZ CResult_UpdateAddHTLCDecodeErrorZ_err(struct LDKDecodeError e);
9125 * Frees any resources used by the CResult_UpdateAddHTLCDecodeErrorZ.
9127 void CResult_UpdateAddHTLCDecodeErrorZ_free(struct LDKCResult_UpdateAddHTLCDecodeErrorZ _res);
9130 * Creates a new CResult_UpdateAddHTLCDecodeErrorZ which has the same data as `orig`
9131 * but with all dynamically-allocated buffers duplicated in new buffers.
9133 struct LDKCResult_UpdateAddHTLCDecodeErrorZ CResult_UpdateAddHTLCDecodeErrorZ_clone(const struct LDKCResult_UpdateAddHTLCDecodeErrorZ *NONNULL_PTR orig);
9136 * Creates a new CResult_PingDecodeErrorZ in the success state.
9138 struct LDKCResult_PingDecodeErrorZ CResult_PingDecodeErrorZ_ok(struct LDKPing o);
9141 * Creates a new CResult_PingDecodeErrorZ in the error state.
9143 struct LDKCResult_PingDecodeErrorZ CResult_PingDecodeErrorZ_err(struct LDKDecodeError e);
9146 * Frees any resources used by the CResult_PingDecodeErrorZ.
9148 void CResult_PingDecodeErrorZ_free(struct LDKCResult_PingDecodeErrorZ _res);
9151 * Creates a new CResult_PingDecodeErrorZ which has the same data as `orig`
9152 * but with all dynamically-allocated buffers duplicated in new buffers.
9154 struct LDKCResult_PingDecodeErrorZ CResult_PingDecodeErrorZ_clone(const struct LDKCResult_PingDecodeErrorZ *NONNULL_PTR orig);
9157 * Creates a new CResult_PongDecodeErrorZ in the success state.
9159 struct LDKCResult_PongDecodeErrorZ CResult_PongDecodeErrorZ_ok(struct LDKPong o);
9162 * Creates a new CResult_PongDecodeErrorZ in the error state.
9164 struct LDKCResult_PongDecodeErrorZ CResult_PongDecodeErrorZ_err(struct LDKDecodeError e);
9167 * Frees any resources used by the CResult_PongDecodeErrorZ.
9169 void CResult_PongDecodeErrorZ_free(struct LDKCResult_PongDecodeErrorZ _res);
9172 * Creates a new CResult_PongDecodeErrorZ which has the same data as `orig`
9173 * but with all dynamically-allocated buffers duplicated in new buffers.
9175 struct LDKCResult_PongDecodeErrorZ CResult_PongDecodeErrorZ_clone(const struct LDKCResult_PongDecodeErrorZ *NONNULL_PTR orig);
9178 * Creates a new CResult_UnsignedChannelAnnouncementDecodeErrorZ in the success state.
9180 struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ CResult_UnsignedChannelAnnouncementDecodeErrorZ_ok(struct LDKUnsignedChannelAnnouncement o);
9183 * Creates a new CResult_UnsignedChannelAnnouncementDecodeErrorZ in the error state.
9185 struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ CResult_UnsignedChannelAnnouncementDecodeErrorZ_err(struct LDKDecodeError e);
9188 * Frees any resources used by the CResult_UnsignedChannelAnnouncementDecodeErrorZ.
9190 void CResult_UnsignedChannelAnnouncementDecodeErrorZ_free(struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ _res);
9193 * Creates a new CResult_UnsignedChannelAnnouncementDecodeErrorZ which has the same data as `orig`
9194 * but with all dynamically-allocated buffers duplicated in new buffers.
9196 struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ CResult_UnsignedChannelAnnouncementDecodeErrorZ_clone(const struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ *NONNULL_PTR orig);
9199 * Creates a new CResult_ChannelAnnouncementDecodeErrorZ in the success state.
9201 struct LDKCResult_ChannelAnnouncementDecodeErrorZ CResult_ChannelAnnouncementDecodeErrorZ_ok(struct LDKChannelAnnouncement o);
9204 * Creates a new CResult_ChannelAnnouncementDecodeErrorZ in the error state.
9206 struct LDKCResult_ChannelAnnouncementDecodeErrorZ CResult_ChannelAnnouncementDecodeErrorZ_err(struct LDKDecodeError e);
9209 * Frees any resources used by the CResult_ChannelAnnouncementDecodeErrorZ.
9211 void CResult_ChannelAnnouncementDecodeErrorZ_free(struct LDKCResult_ChannelAnnouncementDecodeErrorZ _res);
9214 * Creates a new CResult_ChannelAnnouncementDecodeErrorZ which has the same data as `orig`
9215 * but with all dynamically-allocated buffers duplicated in new buffers.
9217 struct LDKCResult_ChannelAnnouncementDecodeErrorZ CResult_ChannelAnnouncementDecodeErrorZ_clone(const struct LDKCResult_ChannelAnnouncementDecodeErrorZ *NONNULL_PTR orig);
9220 * Creates a new CResult_UnsignedChannelUpdateDecodeErrorZ in the success state.
9222 struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ CResult_UnsignedChannelUpdateDecodeErrorZ_ok(struct LDKUnsignedChannelUpdate o);
9225 * Creates a new CResult_UnsignedChannelUpdateDecodeErrorZ in the error state.
9227 struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ CResult_UnsignedChannelUpdateDecodeErrorZ_err(struct LDKDecodeError e);
9230 * Frees any resources used by the CResult_UnsignedChannelUpdateDecodeErrorZ.
9232 void CResult_UnsignedChannelUpdateDecodeErrorZ_free(struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ _res);
9235 * Creates a new CResult_UnsignedChannelUpdateDecodeErrorZ which has the same data as `orig`
9236 * but with all dynamically-allocated buffers duplicated in new buffers.
9238 struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ CResult_UnsignedChannelUpdateDecodeErrorZ_clone(const struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ *NONNULL_PTR orig);
9241 * Creates a new CResult_ChannelUpdateDecodeErrorZ in the success state.
9243 struct LDKCResult_ChannelUpdateDecodeErrorZ CResult_ChannelUpdateDecodeErrorZ_ok(struct LDKChannelUpdate o);
9246 * Creates a new CResult_ChannelUpdateDecodeErrorZ in the error state.
9248 struct LDKCResult_ChannelUpdateDecodeErrorZ CResult_ChannelUpdateDecodeErrorZ_err(struct LDKDecodeError e);
9251 * Frees any resources used by the CResult_ChannelUpdateDecodeErrorZ.
9253 void CResult_ChannelUpdateDecodeErrorZ_free(struct LDKCResult_ChannelUpdateDecodeErrorZ _res);
9256 * Creates a new CResult_ChannelUpdateDecodeErrorZ which has the same data as `orig`
9257 * but with all dynamically-allocated buffers duplicated in new buffers.
9259 struct LDKCResult_ChannelUpdateDecodeErrorZ CResult_ChannelUpdateDecodeErrorZ_clone(const struct LDKCResult_ChannelUpdateDecodeErrorZ *NONNULL_PTR orig);
9262 * Creates a new CResult_ErrorMessageDecodeErrorZ in the success state.
9264 struct LDKCResult_ErrorMessageDecodeErrorZ CResult_ErrorMessageDecodeErrorZ_ok(struct LDKErrorMessage o);
9267 * Creates a new CResult_ErrorMessageDecodeErrorZ in the error state.
9269 struct LDKCResult_ErrorMessageDecodeErrorZ CResult_ErrorMessageDecodeErrorZ_err(struct LDKDecodeError e);
9272 * Frees any resources used by the CResult_ErrorMessageDecodeErrorZ.
9274 void CResult_ErrorMessageDecodeErrorZ_free(struct LDKCResult_ErrorMessageDecodeErrorZ _res);
9277 * Creates a new CResult_ErrorMessageDecodeErrorZ which has the same data as `orig`
9278 * but with all dynamically-allocated buffers duplicated in new buffers.
9280 struct LDKCResult_ErrorMessageDecodeErrorZ CResult_ErrorMessageDecodeErrorZ_clone(const struct LDKCResult_ErrorMessageDecodeErrorZ *NONNULL_PTR orig);
9283 * Creates a new CResult_UnsignedNodeAnnouncementDecodeErrorZ in the success state.
9285 struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ CResult_UnsignedNodeAnnouncementDecodeErrorZ_ok(struct LDKUnsignedNodeAnnouncement o);
9288 * Creates a new CResult_UnsignedNodeAnnouncementDecodeErrorZ in the error state.
9290 struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ CResult_UnsignedNodeAnnouncementDecodeErrorZ_err(struct LDKDecodeError e);
9293 * Frees any resources used by the CResult_UnsignedNodeAnnouncementDecodeErrorZ.
9295 void CResult_UnsignedNodeAnnouncementDecodeErrorZ_free(struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ _res);
9298 * Creates a new CResult_UnsignedNodeAnnouncementDecodeErrorZ which has the same data as `orig`
9299 * but with all dynamically-allocated buffers duplicated in new buffers.
9301 struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ CResult_UnsignedNodeAnnouncementDecodeErrorZ_clone(const struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ *NONNULL_PTR orig);
9304 * Creates a new CResult_NodeAnnouncementDecodeErrorZ in the success state.
9306 struct LDKCResult_NodeAnnouncementDecodeErrorZ CResult_NodeAnnouncementDecodeErrorZ_ok(struct LDKNodeAnnouncement o);
9309 * Creates a new CResult_NodeAnnouncementDecodeErrorZ in the error state.
9311 struct LDKCResult_NodeAnnouncementDecodeErrorZ CResult_NodeAnnouncementDecodeErrorZ_err(struct LDKDecodeError e);
9314 * Frees any resources used by the CResult_NodeAnnouncementDecodeErrorZ.
9316 void CResult_NodeAnnouncementDecodeErrorZ_free(struct LDKCResult_NodeAnnouncementDecodeErrorZ _res);
9319 * Creates a new CResult_NodeAnnouncementDecodeErrorZ which has the same data as `orig`
9320 * but with all dynamically-allocated buffers duplicated in new buffers.
9322 struct LDKCResult_NodeAnnouncementDecodeErrorZ CResult_NodeAnnouncementDecodeErrorZ_clone(const struct LDKCResult_NodeAnnouncementDecodeErrorZ *NONNULL_PTR orig);
9325 * Creates a new CResult_QueryShortChannelIdsDecodeErrorZ in the success state.
9327 struct LDKCResult_QueryShortChannelIdsDecodeErrorZ CResult_QueryShortChannelIdsDecodeErrorZ_ok(struct LDKQueryShortChannelIds o);
9330 * Creates a new CResult_QueryShortChannelIdsDecodeErrorZ in the error state.
9332 struct LDKCResult_QueryShortChannelIdsDecodeErrorZ CResult_QueryShortChannelIdsDecodeErrorZ_err(struct LDKDecodeError e);
9335 * Frees any resources used by the CResult_QueryShortChannelIdsDecodeErrorZ.
9337 void CResult_QueryShortChannelIdsDecodeErrorZ_free(struct LDKCResult_QueryShortChannelIdsDecodeErrorZ _res);
9340 * Creates a new CResult_QueryShortChannelIdsDecodeErrorZ which has the same data as `orig`
9341 * but with all dynamically-allocated buffers duplicated in new buffers.
9343 struct LDKCResult_QueryShortChannelIdsDecodeErrorZ CResult_QueryShortChannelIdsDecodeErrorZ_clone(const struct LDKCResult_QueryShortChannelIdsDecodeErrorZ *NONNULL_PTR orig);
9346 * Creates a new CResult_ReplyShortChannelIdsEndDecodeErrorZ in the success state.
9348 struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ CResult_ReplyShortChannelIdsEndDecodeErrorZ_ok(struct LDKReplyShortChannelIdsEnd o);
9351 * Creates a new CResult_ReplyShortChannelIdsEndDecodeErrorZ in the error state.
9353 struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ CResult_ReplyShortChannelIdsEndDecodeErrorZ_err(struct LDKDecodeError e);
9356 * Frees any resources used by the CResult_ReplyShortChannelIdsEndDecodeErrorZ.
9358 void CResult_ReplyShortChannelIdsEndDecodeErrorZ_free(struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ _res);
9361 * Creates a new CResult_ReplyShortChannelIdsEndDecodeErrorZ which has the same data as `orig`
9362 * but with all dynamically-allocated buffers duplicated in new buffers.
9364 struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ CResult_ReplyShortChannelIdsEndDecodeErrorZ_clone(const struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ *NONNULL_PTR orig);
9367 * Creates a new CResult_QueryChannelRangeDecodeErrorZ in the success state.
9369 struct LDKCResult_QueryChannelRangeDecodeErrorZ CResult_QueryChannelRangeDecodeErrorZ_ok(struct LDKQueryChannelRange o);
9372 * Creates a new CResult_QueryChannelRangeDecodeErrorZ in the error state.
9374 struct LDKCResult_QueryChannelRangeDecodeErrorZ CResult_QueryChannelRangeDecodeErrorZ_err(struct LDKDecodeError e);
9377 * Frees any resources used by the CResult_QueryChannelRangeDecodeErrorZ.
9379 void CResult_QueryChannelRangeDecodeErrorZ_free(struct LDKCResult_QueryChannelRangeDecodeErrorZ _res);
9382 * Creates a new CResult_QueryChannelRangeDecodeErrorZ which has the same data as `orig`
9383 * but with all dynamically-allocated buffers duplicated in new buffers.
9385 struct LDKCResult_QueryChannelRangeDecodeErrorZ CResult_QueryChannelRangeDecodeErrorZ_clone(const struct LDKCResult_QueryChannelRangeDecodeErrorZ *NONNULL_PTR orig);
9388 * Creates a new CResult_ReplyChannelRangeDecodeErrorZ in the success state.
9390 struct LDKCResult_ReplyChannelRangeDecodeErrorZ CResult_ReplyChannelRangeDecodeErrorZ_ok(struct LDKReplyChannelRange o);
9393 * Creates a new CResult_ReplyChannelRangeDecodeErrorZ in the error state.
9395 struct LDKCResult_ReplyChannelRangeDecodeErrorZ CResult_ReplyChannelRangeDecodeErrorZ_err(struct LDKDecodeError e);
9398 * Frees any resources used by the CResult_ReplyChannelRangeDecodeErrorZ.
9400 void CResult_ReplyChannelRangeDecodeErrorZ_free(struct LDKCResult_ReplyChannelRangeDecodeErrorZ _res);
9403 * Creates a new CResult_ReplyChannelRangeDecodeErrorZ which has the same data as `orig`
9404 * but with all dynamically-allocated buffers duplicated in new buffers.
9406 struct LDKCResult_ReplyChannelRangeDecodeErrorZ CResult_ReplyChannelRangeDecodeErrorZ_clone(const struct LDKCResult_ReplyChannelRangeDecodeErrorZ *NONNULL_PTR orig);
9409 * Creates a new CResult_GossipTimestampFilterDecodeErrorZ in the success state.
9411 struct LDKCResult_GossipTimestampFilterDecodeErrorZ CResult_GossipTimestampFilterDecodeErrorZ_ok(struct LDKGossipTimestampFilter o);
9414 * Creates a new CResult_GossipTimestampFilterDecodeErrorZ in the error state.
9416 struct LDKCResult_GossipTimestampFilterDecodeErrorZ CResult_GossipTimestampFilterDecodeErrorZ_err(struct LDKDecodeError e);
9419 * Frees any resources used by the CResult_GossipTimestampFilterDecodeErrorZ.
9421 void CResult_GossipTimestampFilterDecodeErrorZ_free(struct LDKCResult_GossipTimestampFilterDecodeErrorZ _res);
9424 * Creates a new CResult_GossipTimestampFilterDecodeErrorZ which has the same data as `orig`
9425 * but with all dynamically-allocated buffers duplicated in new buffers.
9427 struct LDKCResult_GossipTimestampFilterDecodeErrorZ CResult_GossipTimestampFilterDecodeErrorZ_clone(const struct LDKCResult_GossipTimestampFilterDecodeErrorZ *NONNULL_PTR orig);
9430 * Frees any resources used by the Event
9432 void Event_free(struct LDKEvent this_ptr);
9435 * Creates a copy of the Event
9437 struct LDKEvent Event_clone(const struct LDKEvent *NONNULL_PTR orig);
9440 * Serialize the Event object into a byte array which can be read by Event_read
9442 struct LDKCVec_u8Z Event_write(const struct LDKEvent *NONNULL_PTR obj);
9445 * Frees any resources used by the MessageSendEvent
9447 void MessageSendEvent_free(struct LDKMessageSendEvent this_ptr);
9450 * Creates a copy of the MessageSendEvent
9452 struct LDKMessageSendEvent MessageSendEvent_clone(const struct LDKMessageSendEvent *NONNULL_PTR orig);
9455 * Calls the free function if one is set
9457 void MessageSendEventsProvider_free(struct LDKMessageSendEventsProvider this_ptr);
9460 * Calls the free function if one is set
9462 void EventsProvider_free(struct LDKEventsProvider this_ptr);
9465 * Frees any resources used by the APIError
9467 void APIError_free(struct LDKAPIError this_ptr);
9470 * Creates a copy of the APIError
9472 struct LDKAPIError APIError_clone(const struct LDKAPIError *NONNULL_PTR orig);
9475 * Creates a copy of the Level
9477 enum LDKLevel Level_clone(const enum LDKLevel *NONNULL_PTR orig);
9480 * Returns the most verbose logging level.
9482 MUST_USE_RES enum LDKLevel Level_max(void);
9485 * Calls the free function if one is set
9487 void Logger_free(struct LDKLogger this_ptr);
9490 * Frees any resources used by the ChannelHandshakeConfig, if is_owned is set and inner is non-NULL.
9492 void ChannelHandshakeConfig_free(struct LDKChannelHandshakeConfig this_obj);
9495 * Confirmations we will wait for before considering the channel locked in.
9496 * Applied only for inbound channels (see ChannelHandshakeLimits::max_minimum_depth for the
9497 * equivalent limit applied to outbound channels).
9501 uint32_t ChannelHandshakeConfig_get_minimum_depth(const struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr);
9504 * Confirmations we will wait for before considering the channel locked in.
9505 * Applied only for inbound channels (see ChannelHandshakeLimits::max_minimum_depth for the
9506 * equivalent limit applied to outbound channels).
9510 void ChannelHandshakeConfig_set_minimum_depth(struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr, uint32_t val);
9513 * Set to the number of blocks we require our counterparty to wait to claim their money (ie
9514 * the number of blocks we have to punish our counterparty if they broadcast a revoked
9517 * This is one of the main parameters of our security model. We (or one of our watchtowers) MUST
9518 * be online to check for revoked transactions on-chain at least once every our_to_self_delay
9519 * blocks (minus some margin to allow us enough time to broadcast and confirm a transaction,
9520 * possibly with time in between to RBF the spending transaction).
9522 * Meanwhile, asking for a too high delay, we bother peer to freeze funds for nothing in
9523 * case of an honest unilateral channel close, which implicitly decrease the economic value of
9526 * Default value: [`BREAKDOWN_TIMEOUT`], we enforce it as a minimum at channel opening so you
9527 * can tweak config to ask for more security, not less.
9529 uint16_t ChannelHandshakeConfig_get_our_to_self_delay(const struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr);
9532 * Set to the number of blocks we require our counterparty to wait to claim their money (ie
9533 * the number of blocks we have to punish our counterparty if they broadcast a revoked
9536 * This is one of the main parameters of our security model. We (or one of our watchtowers) MUST
9537 * be online to check for revoked transactions on-chain at least once every our_to_self_delay
9538 * blocks (minus some margin to allow us enough time to broadcast and confirm a transaction,
9539 * possibly with time in between to RBF the spending transaction).
9541 * Meanwhile, asking for a too high delay, we bother peer to freeze funds for nothing in
9542 * case of an honest unilateral channel close, which implicitly decrease the economic value of
9545 * Default value: [`BREAKDOWN_TIMEOUT`], we enforce it as a minimum at channel opening so you
9546 * can tweak config to ask for more security, not less.
9548 void ChannelHandshakeConfig_set_our_to_self_delay(struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr, uint16_t val);
9551 * Set to the smallest value HTLC we will accept to process.
9553 * This value is sent to our counterparty on channel-open and we close the channel any time
9554 * our counterparty misbehaves by sending us an HTLC with a value smaller than this.
9556 * Default value: 1. If the value is less than 1, it is ignored and set to 1, as is required
9559 uint64_t ChannelHandshakeConfig_get_our_htlc_minimum_msat(const struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr);
9562 * Set to the smallest value HTLC we will accept to process.
9564 * This value is sent to our counterparty on channel-open and we close the channel any time
9565 * our counterparty misbehaves by sending us an HTLC with a value smaller than this.
9567 * Default value: 1. If the value is less than 1, it is ignored and set to 1, as is required
9570 void ChannelHandshakeConfig_set_our_htlc_minimum_msat(struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr, uint64_t val);
9573 * Constructs a new ChannelHandshakeConfig given each field
9575 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);
9578 * Creates a copy of the ChannelHandshakeConfig
9580 struct LDKChannelHandshakeConfig ChannelHandshakeConfig_clone(const struct LDKChannelHandshakeConfig *NONNULL_PTR orig);
9583 * Creates a "default" ChannelHandshakeConfig. See struct and individual field documentaiton for details on which values are used.
9585 MUST_USE_RES struct LDKChannelHandshakeConfig ChannelHandshakeConfig_default(void);
9588 * Frees any resources used by the ChannelHandshakeLimits, if is_owned is set and inner is non-NULL.
9590 void ChannelHandshakeLimits_free(struct LDKChannelHandshakeLimits this_obj);
9593 * Minimum allowed satoshis when a channel is funded, this is supplied by the sender and so
9594 * only applies to inbound channels.
9598 uint64_t ChannelHandshakeLimits_get_min_funding_satoshis(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
9601 * Minimum allowed satoshis when a channel is funded, this is supplied by the sender and so
9602 * only applies to inbound channels.
9606 void ChannelHandshakeLimits_set_min_funding_satoshis(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint64_t val);
9609 * The remote node sets a limit on the minimum size of HTLCs we can send to them. This allows
9610 * you to limit the maximum minimum-size they can require.
9612 * Default value: u64::max_value.
9614 uint64_t ChannelHandshakeLimits_get_max_htlc_minimum_msat(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
9617 * The remote node sets a limit on the minimum size of HTLCs we can send to them. This allows
9618 * you to limit the maximum minimum-size they can require.
9620 * Default value: u64::max_value.
9622 void ChannelHandshakeLimits_set_max_htlc_minimum_msat(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint64_t val);
9625 * The remote node sets a limit on the maximum value of pending HTLCs to them at any given
9626 * time to limit their funds exposure to HTLCs. This allows you to set a minimum such value.
9630 uint64_t ChannelHandshakeLimits_get_min_max_htlc_value_in_flight_msat(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
9633 * The remote node sets a limit on the maximum value of pending HTLCs to them at any given
9634 * time to limit their funds exposure to HTLCs. This allows you to set a minimum such value.
9638 void ChannelHandshakeLimits_set_min_max_htlc_value_in_flight_msat(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint64_t val);
9641 * The remote node will require we keep a certain amount in direct payment to ourselves at all
9642 * time, ensuring that we are able to be punished if we broadcast an old state. This allows to
9643 * you limit the amount which we will have to keep to ourselves (and cannot use for HTLCs).
9645 * Default value: u64::max_value.
9647 uint64_t ChannelHandshakeLimits_get_max_channel_reserve_satoshis(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
9650 * The remote node will require we keep a certain amount in direct payment to ourselves at all
9651 * time, ensuring that we are able to be punished if we broadcast an old state. This allows to
9652 * you limit the amount which we will have to keep to ourselves (and cannot use for HTLCs).
9654 * Default value: u64::max_value.
9656 void ChannelHandshakeLimits_set_max_channel_reserve_satoshis(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint64_t val);
9659 * The remote node sets a limit on the maximum number of pending HTLCs to them at any given
9660 * time. This allows you to set a minimum such value.
9664 uint16_t ChannelHandshakeLimits_get_min_max_accepted_htlcs(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
9667 * The remote node sets a limit on the maximum number of pending HTLCs to them at any given
9668 * time. This allows you to set a minimum such value.
9672 void ChannelHandshakeLimits_set_min_max_accepted_htlcs(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint16_t val);
9675 * Outputs below a certain value will not be added to on-chain transactions. The dust value is
9676 * required to always be higher than this value so this only applies to HTLC outputs (and
9677 * potentially to-self outputs before any payments have been made).
9678 * Thus, HTLCs below this amount plus HTLC transaction fees are not enforceable on-chain.
9679 * This setting allows you to set a minimum dust limit for their commitment transactions,
9680 * reflecting the reality that tiny outputs are not considered standard transactions and will
9681 * not propagate through the Bitcoin network.
9683 * Default value: 546, the current dust limit on the Bitcoin network.
9685 uint64_t ChannelHandshakeLimits_get_min_dust_limit_satoshis(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
9688 * Outputs below a certain value will not be added to on-chain transactions. The dust value is
9689 * required to always be higher than this value so this only applies to HTLC outputs (and
9690 * potentially to-self outputs before any payments have been made).
9691 * Thus, HTLCs below this amount plus HTLC transaction fees are not enforceable on-chain.
9692 * This setting allows you to set a minimum dust limit for their commitment transactions,
9693 * reflecting the reality that tiny outputs are not considered standard transactions and will
9694 * not propagate through the Bitcoin network.
9696 * Default value: 546, the current dust limit on the Bitcoin network.
9698 void ChannelHandshakeLimits_set_min_dust_limit_satoshis(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint64_t val);
9701 * Maximum allowed threshold above which outputs will not be generated in their commitment
9703 * HTLCs below this amount plus HTLC transaction fees are not enforceable on-chain.
9705 * Default value: u64::max_value.
9707 uint64_t ChannelHandshakeLimits_get_max_dust_limit_satoshis(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
9710 * Maximum allowed threshold above which outputs will not be generated in their commitment
9712 * HTLCs below this amount plus HTLC transaction fees are not enforceable on-chain.
9714 * Default value: u64::max_value.
9716 void ChannelHandshakeLimits_set_max_dust_limit_satoshis(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint64_t val);
9719 * Before a channel is usable the funding transaction will need to be confirmed by at least a
9720 * certain number of blocks, specified by the node which is not the funder (as the funder can
9721 * assume they aren't going to double-spend themselves).
9722 * This config allows you to set a limit on the maximum amount of time to wait.
9724 * Default value: 144, or roughly one day and only applies to outbound channels.
9726 uint32_t ChannelHandshakeLimits_get_max_minimum_depth(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
9729 * Before a channel is usable the funding transaction will need to be confirmed by at least a
9730 * certain number of blocks, specified by the node which is not the funder (as the funder can
9731 * assume they aren't going to double-spend themselves).
9732 * This config allows you to set a limit on the maximum amount of time to wait.
9734 * Default value: 144, or roughly one day and only applies to outbound channels.
9736 void ChannelHandshakeLimits_set_max_minimum_depth(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint32_t val);
9739 * Set to force the incoming channel to match our announced channel preference in
9742 * Default value: true, to make the default that no announced channels are possible (which is
9743 * appropriate for any nodes which are not online very reliably).
9745 bool ChannelHandshakeLimits_get_force_announced_channel_preference(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
9748 * Set to force the incoming channel to match our announced channel preference in
9751 * Default value: true, to make the default that no announced channels are possible (which is
9752 * appropriate for any nodes which are not online very reliably).
9754 void ChannelHandshakeLimits_set_force_announced_channel_preference(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, bool val);
9757 * Set to the amount of time we're willing to wait to claim money back to us.
9759 * Not checking this value would be a security issue, as our peer would be able to set it to
9760 * max relative lock-time (a year) and we would \"lose\" money as it would be locked for a long time.
9762 * Default value: 2016, which we also enforce as a maximum value so you can tweak config to
9763 * reduce the loss of having useless locked funds (if your peer accepts)
9765 uint16_t ChannelHandshakeLimits_get_their_to_self_delay(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
9768 * Set to the amount of time we're willing to wait to claim money back to us.
9770 * Not checking this value would be a security issue, as our peer would be able to set it to
9771 * max relative lock-time (a year) and we would \"lose\" money as it would be locked for a long time.
9773 * Default value: 2016, which we also enforce as a maximum value so you can tweak config to
9774 * reduce the loss of having useless locked funds (if your peer accepts)
9776 void ChannelHandshakeLimits_set_their_to_self_delay(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint16_t val);
9779 * Constructs a new ChannelHandshakeLimits given each field
9781 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, uint64_t min_dust_limit_satoshis_arg, uint64_t max_dust_limit_satoshis_arg, uint32_t max_minimum_depth_arg, bool force_announced_channel_preference_arg, uint16_t their_to_self_delay_arg);
9784 * Creates a copy of the ChannelHandshakeLimits
9786 struct LDKChannelHandshakeLimits ChannelHandshakeLimits_clone(const struct LDKChannelHandshakeLimits *NONNULL_PTR orig);
9789 * Creates a "default" ChannelHandshakeLimits. See struct and individual field documentaiton for details on which values are used.
9791 MUST_USE_RES struct LDKChannelHandshakeLimits ChannelHandshakeLimits_default(void);
9794 * Frees any resources used by the ChannelConfig, if is_owned is set and inner is non-NULL.
9796 void ChannelConfig_free(struct LDKChannelConfig this_obj);
9799 * Amount (in millionths of a satoshi) the channel will charge per transferred satoshi.
9800 * This may be allowed to change at runtime in a later update, however doing so must result in
9801 * update messages sent to notify all nodes of our updated relay fee.
9805 uint32_t ChannelConfig_get_fee_proportional_millionths(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
9808 * Amount (in millionths of a satoshi) the channel will charge per transferred satoshi.
9809 * This may be allowed to change at runtime in a later update, however doing so must result in
9810 * update messages sent to notify all nodes of our updated relay fee.
9814 void ChannelConfig_set_fee_proportional_millionths(struct LDKChannelConfig *NONNULL_PTR this_ptr, uint32_t val);
9817 * The difference in the CLTV value between incoming HTLCs and an outbound HTLC forwarded over
9818 * the channel this config applies to.
9820 * This is analogous to [`ChannelHandshakeConfig::our_to_self_delay`] but applies to in-flight
9821 * HTLC balance when a channel appears on-chain whereas
9822 * [`ChannelHandshakeConfig::our_to_self_delay`] applies to the remaining
9823 * (non-HTLC-encumbered) balance.
9825 * Thus, for HTLC-encumbered balances to be enforced on-chain when a channel is force-closed,
9826 * we (or one of our watchtowers) MUST be online to check for broadcast of the current
9827 * commitment transaction at least once per this many blocks (minus some margin to allow us
9828 * enough time to broadcast and confirm a transaction, possibly with time in between to RBF
9829 * the spending transaction).
9831 * Default value: 72 (12 hours at an average of 6 blocks/hour).
9832 * Minimum value: [`MIN_CLTV_EXPIRY_DELTA`], any values less than this will be treated as
9833 * [`MIN_CLTV_EXPIRY_DELTA`] instead.
9835 * [`MIN_CLTV_EXPIRY_DELTA`]: crate::ln::channelmanager::MIN_CLTV_EXPIRY_DELTA
9837 uint16_t ChannelConfig_get_cltv_expiry_delta(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
9840 * The difference in the CLTV value between incoming HTLCs and an outbound HTLC forwarded over
9841 * the channel this config applies to.
9843 * This is analogous to [`ChannelHandshakeConfig::our_to_self_delay`] but applies to in-flight
9844 * HTLC balance when a channel appears on-chain whereas
9845 * [`ChannelHandshakeConfig::our_to_self_delay`] applies to the remaining
9846 * (non-HTLC-encumbered) balance.
9848 * Thus, for HTLC-encumbered balances to be enforced on-chain when a channel is force-closed,
9849 * we (or one of our watchtowers) MUST be online to check for broadcast of the current
9850 * commitment transaction at least once per this many blocks (minus some margin to allow us
9851 * enough time to broadcast and confirm a transaction, possibly with time in between to RBF
9852 * the spending transaction).
9854 * Default value: 72 (12 hours at an average of 6 blocks/hour).
9855 * Minimum value: [`MIN_CLTV_EXPIRY_DELTA`], any values less than this will be treated as
9856 * [`MIN_CLTV_EXPIRY_DELTA`] instead.
9858 * [`MIN_CLTV_EXPIRY_DELTA`]: crate::ln::channelmanager::MIN_CLTV_EXPIRY_DELTA
9860 void ChannelConfig_set_cltv_expiry_delta(struct LDKChannelConfig *NONNULL_PTR this_ptr, uint16_t val);
9863 * Set to announce the channel publicly and notify all nodes that they can route via this
9866 * This should only be set to true for nodes which expect to be online reliably.
9868 * As the node which funds a channel picks this value this will only apply for new outbound
9869 * channels unless ChannelHandshakeLimits::force_announced_channel_preferences is set.
9871 * This cannot be changed after the initial channel handshake.
9873 * Default value: false.
9875 bool ChannelConfig_get_announced_channel(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
9878 * Set to announce the channel publicly and notify all nodes that they can route via this
9881 * This should only be set to true for nodes which expect to be online reliably.
9883 * As the node which funds a channel picks this value this will only apply for new outbound
9884 * channels unless ChannelHandshakeLimits::force_announced_channel_preferences is set.
9886 * This cannot be changed after the initial channel handshake.
9888 * Default value: false.
9890 void ChannelConfig_set_announced_channel(struct LDKChannelConfig *NONNULL_PTR this_ptr, bool val);
9893 * When set, we commit to an upfront shutdown_pubkey at channel open. If our counterparty
9894 * supports it, they will then enforce the mutual-close output to us matches what we provided
9895 * at intialization, preventing us from closing to an alternate pubkey.
9897 * This is set to true by default to provide a slight increase in security, though ultimately
9898 * any attacker who is able to take control of a channel can just as easily send the funds via
9899 * lightning payments, so we never require that our counterparties support this option.
9901 * This cannot be changed after a channel has been initialized.
9903 * Default value: true.
9905 bool ChannelConfig_get_commit_upfront_shutdown_pubkey(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
9908 * When set, we commit to an upfront shutdown_pubkey at channel open. If our counterparty
9909 * supports it, they will then enforce the mutual-close output to us matches what we provided
9910 * at intialization, preventing us from closing to an alternate pubkey.
9912 * This is set to true by default to provide a slight increase in security, though ultimately
9913 * any attacker who is able to take control of a channel can just as easily send the funds via
9914 * lightning payments, so we never require that our counterparties support this option.
9916 * This cannot be changed after a channel has been initialized.
9918 * Default value: true.
9920 void ChannelConfig_set_commit_upfront_shutdown_pubkey(struct LDKChannelConfig *NONNULL_PTR this_ptr, bool val);
9923 * Constructs a new ChannelConfig given each field
9925 MUST_USE_RES struct LDKChannelConfig ChannelConfig_new(uint32_t fee_proportional_millionths_arg, uint16_t cltv_expiry_delta_arg, bool announced_channel_arg, bool commit_upfront_shutdown_pubkey_arg);
9928 * Creates a copy of the ChannelConfig
9930 struct LDKChannelConfig ChannelConfig_clone(const struct LDKChannelConfig *NONNULL_PTR orig);
9933 * Creates a "default" ChannelConfig. See struct and individual field documentaiton for details on which values are used.
9935 MUST_USE_RES struct LDKChannelConfig ChannelConfig_default(void);
9938 * Serialize the ChannelConfig object into a byte array which can be read by ChannelConfig_read
9940 struct LDKCVec_u8Z ChannelConfig_write(const struct LDKChannelConfig *NONNULL_PTR obj);
9943 * Read a ChannelConfig from a byte array, created by ChannelConfig_write
9945 struct LDKCResult_ChannelConfigDecodeErrorZ ChannelConfig_read(struct LDKu8slice ser);
9948 * Frees any resources used by the UserConfig, if is_owned is set and inner is non-NULL.
9950 void UserConfig_free(struct LDKUserConfig this_obj);
9953 * Channel config that we propose to our counterparty.
9955 struct LDKChannelHandshakeConfig UserConfig_get_own_channel_config(const struct LDKUserConfig *NONNULL_PTR this_ptr);
9958 * Channel config that we propose to our counterparty.
9960 void UserConfig_set_own_channel_config(struct LDKUserConfig *NONNULL_PTR this_ptr, struct LDKChannelHandshakeConfig val);
9963 * Limits applied to our counterparty's proposed channel config settings.
9965 struct LDKChannelHandshakeLimits UserConfig_get_peer_channel_config_limits(const struct LDKUserConfig *NONNULL_PTR this_ptr);
9968 * Limits applied to our counterparty's proposed channel config settings.
9970 void UserConfig_set_peer_channel_config_limits(struct LDKUserConfig *NONNULL_PTR this_ptr, struct LDKChannelHandshakeLimits val);
9973 * Channel config which affects behavior during channel lifetime.
9975 struct LDKChannelConfig UserConfig_get_channel_options(const struct LDKUserConfig *NONNULL_PTR this_ptr);
9978 * Channel config which affects behavior during channel lifetime.
9980 void UserConfig_set_channel_options(struct LDKUserConfig *NONNULL_PTR this_ptr, struct LDKChannelConfig val);
9983 * Constructs a new UserConfig given each field
9985 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);
9988 * Creates a copy of the UserConfig
9990 struct LDKUserConfig UserConfig_clone(const struct LDKUserConfig *NONNULL_PTR orig);
9993 * Creates a "default" UserConfig. See struct and individual field documentaiton for details on which values are used.
9995 MUST_USE_RES struct LDKUserConfig UserConfig_default(void);
9998 * Creates a copy of the AccessError
10000 enum LDKAccessError AccessError_clone(const enum LDKAccessError *NONNULL_PTR orig);
10003 * Calls the free function if one is set
10005 void Access_free(struct LDKAccess this_ptr);
10008 * Calls the free function if one is set
10010 void Listen_free(struct LDKListen this_ptr);
10013 * Calls the free function if one is set
10015 void Watch_free(struct LDKWatch this_ptr);
10018 * Calls the free function if one is set
10020 void Filter_free(struct LDKFilter this_ptr);
10023 * Frees any resources used by the WatchedOutput, if is_owned is set and inner is non-NULL.
10025 void WatchedOutput_free(struct LDKWatchedOutput this_obj);
10028 * First block where the transaction output may have been spent.
10030 struct LDKThirtyTwoBytes WatchedOutput_get_block_hash(const struct LDKWatchedOutput *NONNULL_PTR this_ptr);
10033 * First block where the transaction output may have been spent.
10035 void WatchedOutput_set_block_hash(struct LDKWatchedOutput *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
10038 * Outpoint identifying the transaction output.
10040 struct LDKOutPoint WatchedOutput_get_outpoint(const struct LDKWatchedOutput *NONNULL_PTR this_ptr);
10043 * Outpoint identifying the transaction output.
10045 void WatchedOutput_set_outpoint(struct LDKWatchedOutput *NONNULL_PTR this_ptr, struct LDKOutPoint val);
10048 * Spending condition of the transaction output.
10050 struct LDKu8slice WatchedOutput_get_script_pubkey(const struct LDKWatchedOutput *NONNULL_PTR this_ptr);
10053 * Spending condition of the transaction output.
10055 void WatchedOutput_set_script_pubkey(struct LDKWatchedOutput *NONNULL_PTR this_ptr, struct LDKCVec_u8Z val);
10058 * Constructs a new WatchedOutput given each field
10060 MUST_USE_RES struct LDKWatchedOutput WatchedOutput_new(struct LDKThirtyTwoBytes block_hash_arg, struct LDKOutPoint outpoint_arg, struct LDKCVec_u8Z script_pubkey_arg);
10063 * Calls the free function if one is set
10065 void BroadcasterInterface_free(struct LDKBroadcasterInterface this_ptr);
10068 * Creates a copy of the ConfirmationTarget
10070 enum LDKConfirmationTarget ConfirmationTarget_clone(const enum LDKConfirmationTarget *NONNULL_PTR orig);
10073 * Calls the free function if one is set
10075 void FeeEstimator_free(struct LDKFeeEstimator this_ptr);
10078 * Frees any resources used by the ChainMonitor, if is_owned is set and inner is non-NULL.
10080 void ChainMonitor_free(struct LDKChainMonitor this_obj);
10083 * Dispatches to per-channel monitors, which are responsible for updating their on-chain view
10084 * of a channel and reacting accordingly based on transactions in the connected block. See
10085 * [`ChannelMonitor::block_connected`] for details. Any HTLCs that were resolved on chain will
10086 * be returned by [`chain::Watch::release_pending_monitor_events`].
10088 * Calls back to [`chain::Filter`] if any monitor indicated new outputs to watch. Subsequent
10089 * calls must not exclude any transactions matching the new outputs nor any in-block
10090 * descendants of such transactions. It is not necessary to re-fetch the block to obtain
10091 * updated `txdata`.
10093 void ChainMonitor_block_connected(const struct LDKChainMonitor *NONNULL_PTR this_arg, const uint8_t (*header)[80], struct LDKCVec_C2Tuple_usizeTransactionZZ txdata, uint32_t height);
10096 * Dispatches to per-channel monitors, which are responsible for updating their on-chain view
10097 * of a channel based on the disconnected block. See [`ChannelMonitor::block_disconnected`] for
10100 void ChainMonitor_block_disconnected(const struct LDKChainMonitor *NONNULL_PTR this_arg, const uint8_t (*header)[80], uint32_t disconnected_height);
10103 * Creates a new `ChainMonitor` used to watch on-chain activity pertaining to channels.
10105 * When an optional chain source implementing [`chain::Filter`] is provided, the chain monitor
10106 * will call back to it indicating transactions and outputs of interest. This allows clients to
10107 * pre-filter blocks or only fetch blocks matching a compact filter. Otherwise, clients may
10108 * always need to fetch full blocks absent another means for determining which blocks contain
10109 * transactions relevant to the watched channels.
10111 MUST_USE_RES struct LDKChainMonitor ChainMonitor_new(struct LDKFilter *chain_source, struct LDKBroadcasterInterface broadcaster, struct LDKLogger logger, struct LDKFeeEstimator feeest, struct LDKPersist persister);
10114 * Constructs a new Watch which calls the relevant methods on this_arg.
10115 * This copies the `inner` pointer in this_arg and thus the returned Watch must be freed before this_arg is
10117 struct LDKWatch ChainMonitor_as_Watch(const struct LDKChainMonitor *NONNULL_PTR this_arg);
10120 * Constructs a new EventsProvider which calls the relevant methods on this_arg.
10121 * This copies the `inner` pointer in this_arg and thus the returned EventsProvider must be freed before this_arg is
10123 struct LDKEventsProvider ChainMonitor_as_EventsProvider(const struct LDKChainMonitor *NONNULL_PTR this_arg);
10126 * Frees any resources used by the ChannelMonitorUpdate, if is_owned is set and inner is non-NULL.
10128 void ChannelMonitorUpdate_free(struct LDKChannelMonitorUpdate this_obj);
10131 * The sequence number of this update. Updates *must* be replayed in-order according to this
10132 * sequence number (and updates may panic if they are not). The update_id values are strictly
10133 * increasing and increase by one for each new update, with one exception specified below.
10135 * This sequence number is also used to track up to which points updates which returned
10136 * ChannelMonitorUpdateErr::TemporaryFailure have been applied to all copies of a given
10137 * ChannelMonitor when ChannelManager::channel_monitor_updated is called.
10139 * The only instance where update_id values are not strictly increasing is the case where we
10140 * allow post-force-close updates with a special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. See
10141 * its docs for more details.
10143 uint64_t ChannelMonitorUpdate_get_update_id(const struct LDKChannelMonitorUpdate *NONNULL_PTR this_ptr);
10146 * The sequence number of this update. Updates *must* be replayed in-order according to this
10147 * sequence number (and updates may panic if they are not). The update_id values are strictly
10148 * increasing and increase by one for each new update, with one exception specified below.
10150 * This sequence number is also used to track up to which points updates which returned
10151 * ChannelMonitorUpdateErr::TemporaryFailure have been applied to all copies of a given
10152 * ChannelMonitor when ChannelManager::channel_monitor_updated is called.
10154 * The only instance where update_id values are not strictly increasing is the case where we
10155 * allow post-force-close updates with a special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. See
10156 * its docs for more details.
10158 void ChannelMonitorUpdate_set_update_id(struct LDKChannelMonitorUpdate *NONNULL_PTR this_ptr, uint64_t val);
10161 * Creates a copy of the ChannelMonitorUpdate
10163 struct LDKChannelMonitorUpdate ChannelMonitorUpdate_clone(const struct LDKChannelMonitorUpdate *NONNULL_PTR orig);
10166 * Serialize the ChannelMonitorUpdate object into a byte array which can be read by ChannelMonitorUpdate_read
10168 struct LDKCVec_u8Z ChannelMonitorUpdate_write(const struct LDKChannelMonitorUpdate *NONNULL_PTR obj);
10171 * Read a ChannelMonitorUpdate from a byte array, created by ChannelMonitorUpdate_write
10173 struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ ChannelMonitorUpdate_read(struct LDKu8slice ser);
10176 * Creates a copy of the ChannelMonitorUpdateErr
10178 enum LDKChannelMonitorUpdateErr ChannelMonitorUpdateErr_clone(const enum LDKChannelMonitorUpdateErr *NONNULL_PTR orig);
10181 * Frees any resources used by the MonitorUpdateError, if is_owned is set and inner is non-NULL.
10183 void MonitorUpdateError_free(struct LDKMonitorUpdateError this_obj);
10186 * Creates a copy of the MonitorUpdateError
10188 struct LDKMonitorUpdateError MonitorUpdateError_clone(const struct LDKMonitorUpdateError *NONNULL_PTR orig);
10191 * Frees any resources used by the MonitorEvent
10193 void MonitorEvent_free(struct LDKMonitorEvent this_ptr);
10196 * Creates a copy of the MonitorEvent
10198 struct LDKMonitorEvent MonitorEvent_clone(const struct LDKMonitorEvent *NONNULL_PTR orig);
10201 * Frees any resources used by the HTLCUpdate, if is_owned is set and inner is non-NULL.
10203 void HTLCUpdate_free(struct LDKHTLCUpdate this_obj);
10206 * Creates a copy of the HTLCUpdate
10208 struct LDKHTLCUpdate HTLCUpdate_clone(const struct LDKHTLCUpdate *NONNULL_PTR orig);
10211 * Serialize the HTLCUpdate object into a byte array which can be read by HTLCUpdate_read
10213 struct LDKCVec_u8Z HTLCUpdate_write(const struct LDKHTLCUpdate *NONNULL_PTR obj);
10216 * Read a HTLCUpdate from a byte array, created by HTLCUpdate_write
10218 struct LDKCResult_HTLCUpdateDecodeErrorZ HTLCUpdate_read(struct LDKu8slice ser);
10221 * Frees any resources used by the ChannelMonitor, if is_owned is set and inner is non-NULL.
10223 void ChannelMonitor_free(struct LDKChannelMonitor this_obj);
10226 * Serialize the ChannelMonitor object into a byte array which can be read by ChannelMonitor_read
10228 struct LDKCVec_u8Z ChannelMonitor_write(const struct LDKChannelMonitor *NONNULL_PTR obj);
10231 * Updates a ChannelMonitor on the basis of some new information provided by the Channel
10234 * panics if the given update is not the next update by update_id.
10236 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);
10239 * Gets the update_id from the latest ChannelMonitorUpdate which was applied to this
10242 MUST_USE_RES uint64_t ChannelMonitor_get_latest_update_id(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
10245 * Gets the funding transaction outpoint of the channel this ChannelMonitor is monitoring for.
10247 MUST_USE_RES struct LDKC2Tuple_OutPointScriptZ ChannelMonitor_get_funding_txo(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
10250 * Gets a list of txids, with their output scripts (in the order they appear in the
10251 * transaction), which we must learn about spends of via block_connected().
10253 MUST_USE_RES struct LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ ChannelMonitor_get_outputs_to_watch(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
10256 * Loads the funding txo and outputs to watch into the given `chain::Filter` by repeatedly
10257 * calling `chain::Filter::register_output` and `chain::Filter::register_tx` until all outputs
10258 * have been registered.
10260 void ChannelMonitor_load_outputs_to_watch(const struct LDKChannelMonitor *NONNULL_PTR this_arg, const struct LDKFilter *NONNULL_PTR filter);
10263 * Get the list of HTLCs who's status has been updated on chain. This should be called by
10264 * ChannelManager via [`chain::Watch::release_pending_monitor_events`].
10266 MUST_USE_RES struct LDKCVec_MonitorEventZ ChannelMonitor_get_and_clear_pending_monitor_events(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
10269 * Gets the list of pending events which were generated by previous actions, clearing the list
10272 * This is called by ChainMonitor::get_and_clear_pending_events() and is equivalent to
10273 * EventsProvider::get_and_clear_pending_events() except that it requires &mut self as we do
10274 * no internal locking in ChannelMonitors.
10276 MUST_USE_RES struct LDKCVec_EventZ ChannelMonitor_get_and_clear_pending_events(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
10279 * Used by ChannelManager deserialization to broadcast the latest holder state if its copy of
10280 * the Channel was out-of-date. You may use it to get a broadcastable holder toxic tx in case of
10281 * fallen-behind, i.e when receiving a channel_reestablish with a proof that our counterparty side knows
10282 * a higher revocation secret than the holder commitment number we are aware of. Broadcasting these
10283 * transactions are UNSAFE, as they allow counterparty side to punish you. Nevertheless you may want to
10284 * broadcast them if counterparty don't close channel with his higher commitment transaction after a
10285 * substantial amount of time (a month or even a year) to get back funds. Best may be to contact
10286 * out-of-band the other node operator to coordinate with him if option is available to you.
10287 * In any-case, choice is up to the user.
10289 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);
10292 * Processes transactions in a newly connected block, which may result in any of the following:
10293 * - update the monitor's state against resolved HTLCs
10294 * - punish the counterparty in the case of seeing a revoked commitment transaction
10295 * - force close the channel and claim/timeout incoming/outgoing HTLCs if near expiration
10296 * - detect settled outputs for later spending
10297 * - schedule and bump any in-flight claims
10299 * Returns any new outputs to watch from `txdata`; after called, these are also included in
10300 * [`get_outputs_to_watch`].
10302 * [`get_outputs_to_watch`]: #method.get_outputs_to_watch
10304 MUST_USE_RES struct LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZZ 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);
10307 * Determines if the disconnected block contained any transactions of interest and updates
10310 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);
10313 * Calls the free function if one is set
10315 void Persist_free(struct LDKPersist this_ptr);
10318 * Read a C2Tuple_BlockHashChannelMonitorZ from a byte array, created by C2Tuple_BlockHashChannelMonitorZ_write
10320 struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ C2Tuple_BlockHashChannelMonitorZ_read(struct LDKu8slice ser, const struct LDKKeysInterface *NONNULL_PTR arg);
10323 * Frees any resources used by the OutPoint, if is_owned is set and inner is non-NULL.
10325 void OutPoint_free(struct LDKOutPoint this_obj);
10328 * The referenced transaction's txid.
10330 const uint8_t (*OutPoint_get_txid(const struct LDKOutPoint *NONNULL_PTR this_ptr))[32];
10333 * The referenced transaction's txid.
10335 void OutPoint_set_txid(struct LDKOutPoint *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
10338 * The index of the referenced output in its transaction's vout.
10340 uint16_t OutPoint_get_index(const struct LDKOutPoint *NONNULL_PTR this_ptr);
10343 * The index of the referenced output in its transaction's vout.
10345 void OutPoint_set_index(struct LDKOutPoint *NONNULL_PTR this_ptr, uint16_t val);
10348 * Constructs a new OutPoint given each field
10350 MUST_USE_RES struct LDKOutPoint OutPoint_new(struct LDKThirtyTwoBytes txid_arg, uint16_t index_arg);
10353 * Creates a copy of the OutPoint
10355 struct LDKOutPoint OutPoint_clone(const struct LDKOutPoint *NONNULL_PTR orig);
10358 * Convert an `OutPoint` to a lightning channel id.
10360 MUST_USE_RES struct LDKThirtyTwoBytes OutPoint_to_channel_id(const struct LDKOutPoint *NONNULL_PTR this_arg);
10363 * Serialize the OutPoint object into a byte array which can be read by OutPoint_read
10365 struct LDKCVec_u8Z OutPoint_write(const struct LDKOutPoint *NONNULL_PTR obj);
10368 * Read a OutPoint from a byte array, created by OutPoint_write
10370 struct LDKCResult_OutPointDecodeErrorZ OutPoint_read(struct LDKu8slice ser);
10373 * Frees any resources used by the DelayedPaymentOutputDescriptor, if is_owned is set and inner is non-NULL.
10375 void DelayedPaymentOutputDescriptor_free(struct LDKDelayedPaymentOutputDescriptor this_obj);
10378 * The outpoint which is spendable
10380 struct LDKOutPoint DelayedPaymentOutputDescriptor_get_outpoint(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr);
10383 * The outpoint which is spendable
10385 void DelayedPaymentOutputDescriptor_set_outpoint(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKOutPoint val);
10388 * Per commitment point to derive delayed_payment_key by key holder
10390 struct LDKPublicKey DelayedPaymentOutputDescriptor_get_per_commitment_point(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr);
10393 * Per commitment point to derive delayed_payment_key by key holder
10395 void DelayedPaymentOutputDescriptor_set_per_commitment_point(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKPublicKey val);
10398 * The nSequence value which must be set in the spending input to satisfy the OP_CSV in
10399 * the witness_script.
10401 uint16_t DelayedPaymentOutputDescriptor_get_to_self_delay(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr);
10404 * The nSequence value which must be set in the spending input to satisfy the OP_CSV in
10405 * the witness_script.
10407 void DelayedPaymentOutputDescriptor_set_to_self_delay(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, uint16_t val);
10410 * The output which is referenced by the given outpoint
10412 void DelayedPaymentOutputDescriptor_set_output(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKTxOut val);
10415 * The revocation point specific to the commitment transaction which was broadcast. Used to
10416 * derive the witnessScript for this output.
10418 struct LDKPublicKey DelayedPaymentOutputDescriptor_get_revocation_pubkey(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr);
10421 * The revocation point specific to the commitment transaction which was broadcast. Used to
10422 * derive the witnessScript for this output.
10424 void DelayedPaymentOutputDescriptor_set_revocation_pubkey(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKPublicKey val);
10427 * Arbitrary identification information returned by a call to
10428 * `Sign::channel_keys_id()`. This may be useful in re-deriving keys used in
10429 * the channel to spend the output.
10431 const uint8_t (*DelayedPaymentOutputDescriptor_get_channel_keys_id(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr))[32];
10434 * Arbitrary identification information returned by a call to
10435 * `Sign::channel_keys_id()`. This may be useful in re-deriving keys used in
10436 * the channel to spend the output.
10438 void DelayedPaymentOutputDescriptor_set_channel_keys_id(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
10441 * The value of the channel which this output originated from, possibly indirectly.
10443 uint64_t DelayedPaymentOutputDescriptor_get_channel_value_satoshis(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr);
10446 * The value of the channel which this output originated from, possibly indirectly.
10448 void DelayedPaymentOutputDescriptor_set_channel_value_satoshis(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, uint64_t val);
10451 * Constructs a new DelayedPaymentOutputDescriptor given each field
10453 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);
10456 * Creates a copy of the DelayedPaymentOutputDescriptor
10458 struct LDKDelayedPaymentOutputDescriptor DelayedPaymentOutputDescriptor_clone(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR orig);
10461 * Frees any resources used by the StaticPaymentOutputDescriptor, if is_owned is set and inner is non-NULL.
10463 void StaticPaymentOutputDescriptor_free(struct LDKStaticPaymentOutputDescriptor this_obj);
10466 * The outpoint which is spendable
10468 struct LDKOutPoint StaticPaymentOutputDescriptor_get_outpoint(const struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr);
10471 * The outpoint which is spendable
10473 void StaticPaymentOutputDescriptor_set_outpoint(struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKOutPoint val);
10476 * The output which is referenced by the given outpoint
10478 void StaticPaymentOutputDescriptor_set_output(struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKTxOut val);
10481 * Arbitrary identification information returned by a call to
10482 * `Sign::channel_keys_id()`. This may be useful in re-deriving keys used in
10483 * the channel to spend the output.
10485 const uint8_t (*StaticPaymentOutputDescriptor_get_channel_keys_id(const struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr))[32];
10488 * Arbitrary identification information returned by a call to
10489 * `Sign::channel_keys_id()`. This may be useful in re-deriving keys used in
10490 * the channel to spend the output.
10492 void StaticPaymentOutputDescriptor_set_channel_keys_id(struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
10495 * The value of the channel which this transactions spends.
10497 uint64_t StaticPaymentOutputDescriptor_get_channel_value_satoshis(const struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr);
10500 * The value of the channel which this transactions spends.
10502 void StaticPaymentOutputDescriptor_set_channel_value_satoshis(struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr, uint64_t val);
10505 * Constructs a new StaticPaymentOutputDescriptor given each field
10507 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);
10510 * Creates a copy of the StaticPaymentOutputDescriptor
10512 struct LDKStaticPaymentOutputDescriptor StaticPaymentOutputDescriptor_clone(const struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR orig);
10515 * Frees any resources used by the SpendableOutputDescriptor
10517 void SpendableOutputDescriptor_free(struct LDKSpendableOutputDescriptor this_ptr);
10520 * Creates a copy of the SpendableOutputDescriptor
10522 struct LDKSpendableOutputDescriptor SpendableOutputDescriptor_clone(const struct LDKSpendableOutputDescriptor *NONNULL_PTR orig);
10525 * Serialize the SpendableOutputDescriptor object into a byte array which can be read by SpendableOutputDescriptor_read
10527 struct LDKCVec_u8Z SpendableOutputDescriptor_write(const struct LDKSpendableOutputDescriptor *NONNULL_PTR obj);
10530 * Read a SpendableOutputDescriptor from a byte array, created by SpendableOutputDescriptor_write
10532 struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ SpendableOutputDescriptor_read(struct LDKu8slice ser);
10535 * Creates a copy of a Sign
10537 struct LDKSign Sign_clone(const struct LDKSign *NONNULL_PTR orig);
10540 * Calls the free function if one is set
10542 void Sign_free(struct LDKSign this_ptr);
10545 * Calls the free function if one is set
10547 void KeysInterface_free(struct LDKKeysInterface this_ptr);
10550 * Frees any resources used by the InMemorySigner, if is_owned is set and inner is non-NULL.
10552 void InMemorySigner_free(struct LDKInMemorySigner this_obj);
10555 * Private key of anchor tx
10557 const uint8_t (*InMemorySigner_get_funding_key(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
10560 * Private key of anchor tx
10562 void InMemorySigner_set_funding_key(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKSecretKey val);
10565 * Holder secret key for blinded revocation pubkey
10567 const uint8_t (*InMemorySigner_get_revocation_base_key(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
10570 * Holder secret key for blinded revocation pubkey
10572 void InMemorySigner_set_revocation_base_key(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKSecretKey val);
10575 * Holder secret key used for our balance in counterparty-broadcasted commitment transactions
10577 const uint8_t (*InMemorySigner_get_payment_key(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
10580 * Holder secret key used for our balance in counterparty-broadcasted commitment transactions
10582 void InMemorySigner_set_payment_key(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKSecretKey val);
10585 * Holder secret key used in HTLC tx
10587 const uint8_t (*InMemorySigner_get_delayed_payment_base_key(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
10590 * Holder secret key used in HTLC tx
10592 void InMemorySigner_set_delayed_payment_base_key(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKSecretKey val);
10595 * Holder htlc secret key used in commitment tx htlc outputs
10597 const uint8_t (*InMemorySigner_get_htlc_base_key(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
10600 * Holder htlc secret key used in commitment tx htlc outputs
10602 void InMemorySigner_set_htlc_base_key(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKSecretKey val);
10607 const uint8_t (*InMemorySigner_get_commitment_seed(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
10612 void InMemorySigner_set_commitment_seed(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
10615 * Creates a copy of the InMemorySigner
10617 struct LDKInMemorySigner InMemorySigner_clone(const struct LDKInMemorySigner *NONNULL_PTR orig);
10620 * Create a new InMemorySigner
10622 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);
10625 * Counterparty pubkeys.
10626 * Will panic if ready_channel wasn't called.
10628 MUST_USE_RES struct LDKChannelPublicKeys InMemorySigner_counterparty_pubkeys(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
10631 * The contest_delay value specified by our counterparty and applied on holder-broadcastable
10632 * transactions, ie the amount of time that we have to wait to recover our funds if we
10633 * broadcast a transaction.
10634 * Will panic if ready_channel wasn't called.
10636 MUST_USE_RES uint16_t InMemorySigner_counterparty_selected_contest_delay(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
10639 * The contest_delay value specified by us and applied on transactions broadcastable
10640 * by our counterparty, ie the amount of time that they have to wait to recover their funds
10641 * if they broadcast a transaction.
10642 * Will panic if ready_channel wasn't called.
10644 MUST_USE_RES uint16_t InMemorySigner_holder_selected_contest_delay(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
10647 * Whether the holder is the initiator
10648 * Will panic if ready_channel wasn't called.
10650 MUST_USE_RES bool InMemorySigner_is_outbound(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
10654 * Will panic if ready_channel wasn't called.
10656 MUST_USE_RES struct LDKOutPoint InMemorySigner_funding_outpoint(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
10659 * Obtain a ChannelTransactionParameters for this channel, to be used when verifying or
10660 * building transactions.
10662 * Will panic if ready_channel wasn't called.
10664 MUST_USE_RES struct LDKChannelTransactionParameters InMemorySigner_get_channel_parameters(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
10667 * Sign the single input of spend_tx at index `input_idx` which spends the output
10668 * described by descriptor, returning the witness stack for the input.
10670 * Returns an Err if the input at input_idx does not exist, has a non-empty script_sig,
10671 * or is not spending the outpoint described by `descriptor.outpoint`.
10673 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);
10676 * Sign the single input of spend_tx at index `input_idx` which spends the output
10677 * described by descriptor, returning the witness stack for the input.
10679 * Returns an Err if the input at input_idx does not exist, has a non-empty script_sig,
10680 * is not spending the outpoint described by `descriptor.outpoint`, or does not have a
10681 * sequence set to `descriptor.to_self_delay`.
10683 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);
10686 * Constructs a new Sign which calls the relevant methods on this_arg.
10687 * This copies the `inner` pointer in this_arg and thus the returned Sign must be freed before this_arg is
10689 struct LDKSign InMemorySigner_as_Sign(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
10692 * Serialize the InMemorySigner object into a byte array which can be read by InMemorySigner_read
10694 struct LDKCVec_u8Z InMemorySigner_write(const struct LDKInMemorySigner *NONNULL_PTR obj);
10697 * Read a InMemorySigner from a byte array, created by InMemorySigner_write
10699 struct LDKCResult_InMemorySignerDecodeErrorZ InMemorySigner_read(struct LDKu8slice ser);
10702 * Frees any resources used by the KeysManager, if is_owned is set and inner is non-NULL.
10704 void KeysManager_free(struct LDKKeysManager this_obj);
10707 * Constructs a KeysManager from a 32-byte seed. If the seed is in some way biased (eg your
10708 * CSRNG is busted) this may panic (but more importantly, you will possibly lose funds).
10709 * starting_time isn't strictly required to actually be a time, but it must absolutely,
10710 * without a doubt, be unique to this instance. ie if you start multiple times with the same
10711 * seed, starting_time must be unique to each run. Thus, the easiest way to achieve this is to
10712 * simply use the current time (with very high precision).
10714 * The seed MUST be backed up safely prior to use so that the keys can be re-created, however,
10715 * obviously, starting_time should be unique every time you reload the library - it is only
10716 * used to generate new ephemeral key data (which will be stored by the individual channel if
10719 * Note that the seed is required to recover certain on-chain funds independent of
10720 * ChannelMonitor data, though a current copy of ChannelMonitor data is also required for any
10721 * channel, and some on-chain during-closing funds.
10723 * Note that until the 0.1 release there is no guarantee of backward compatibility between
10724 * versions. Once the library is more fully supported, the docs will be updated to include a
10725 * detailed description of the guarantee.
10727 MUST_USE_RES struct LDKKeysManager KeysManager_new(const uint8_t (*seed)[32], uint64_t starting_time_secs, uint32_t starting_time_nanos);
10730 * Derive an old Sign containing per-channel secrets based on a key derivation parameters.
10732 * Key derivation parameters are accessible through a per-channel secrets
10733 * Sign::channel_keys_id and is provided inside DynamicOuputP2WSH in case of
10734 * onchain output detection for which a corresponding delayed_payment_key must be derived.
10736 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]);
10739 * Creates a Transaction which spends the given descriptors to the given outputs, plus an
10740 * output to the given change destination (if sufficient change value remains). The
10741 * transaction will have a feerate, at least, of the given value.
10743 * Returns `Err(())` if the output value is greater than the input value minus required fee or
10744 * if a descriptor was duplicated.
10746 * We do not enforce that outputs meet the dust limit or that any output scripts are standard.
10748 * May panic if the `SpendableOutputDescriptor`s were not generated by Channels which used
10749 * this KeysManager or one of the `InMemorySigner` created by this KeysManager.
10751 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);
10754 * Constructs a new KeysInterface which calls the relevant methods on this_arg.
10755 * This copies the `inner` pointer in this_arg and thus the returned KeysInterface must be freed before this_arg is
10757 struct LDKKeysInterface KeysManager_as_KeysInterface(const struct LDKKeysManager *NONNULL_PTR this_arg);
10760 * Frees any resources used by the ChannelManager, if is_owned is set and inner is non-NULL.
10762 void ChannelManager_free(struct LDKChannelManager this_obj);
10765 * Frees any resources used by the ChainParameters, if is_owned is set and inner is non-NULL.
10767 void ChainParameters_free(struct LDKChainParameters this_obj);
10770 * The network for determining the `chain_hash` in Lightning messages.
10772 enum LDKNetwork ChainParameters_get_network(const struct LDKChainParameters *NONNULL_PTR this_ptr);
10775 * The network for determining the `chain_hash` in Lightning messages.
10777 void ChainParameters_set_network(struct LDKChainParameters *NONNULL_PTR this_ptr, enum LDKNetwork val);
10780 * The hash of the latest block successfully connected.
10782 const uint8_t (*ChainParameters_get_latest_hash(const struct LDKChainParameters *NONNULL_PTR this_ptr))[32];
10785 * The hash of the latest block successfully connected.
10787 void ChainParameters_set_latest_hash(struct LDKChainParameters *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
10790 * The height of the latest block successfully connected.
10792 * Used to track on-chain channel funding outputs and send payments with reliable timelocks.
10794 uintptr_t ChainParameters_get_latest_height(const struct LDKChainParameters *NONNULL_PTR this_ptr);
10797 * The height of the latest block successfully connected.
10799 * Used to track on-chain channel funding outputs and send payments with reliable timelocks.
10801 void ChainParameters_set_latest_height(struct LDKChainParameters *NONNULL_PTR this_ptr, uintptr_t val);
10804 * Constructs a new ChainParameters given each field
10806 MUST_USE_RES struct LDKChainParameters ChainParameters_new(enum LDKNetwork network_arg, struct LDKThirtyTwoBytes latest_hash_arg, uintptr_t latest_height_arg);
10809 * Frees any resources used by the ChannelDetails, if is_owned is set and inner is non-NULL.
10811 void ChannelDetails_free(struct LDKChannelDetails this_obj);
10814 * The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
10815 * thereafter this is the txid of the funding transaction xor the funding transaction output).
10816 * Note that this means this value is *not* persistent - it can change once during the
10817 * lifetime of the channel.
10819 const uint8_t (*ChannelDetails_get_channel_id(const struct LDKChannelDetails *NONNULL_PTR this_ptr))[32];
10822 * The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
10823 * thereafter this is the txid of the funding transaction xor the funding transaction output).
10824 * Note that this means this value is *not* persistent - it can change once during the
10825 * lifetime of the channel.
10827 void ChannelDetails_set_channel_id(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
10830 * The position of the funding transaction in the chain. None if the funding transaction has
10831 * not yet been confirmed and the channel fully opened.
10833 struct LDKCOption_u64Z ChannelDetails_get_short_channel_id(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
10836 * The position of the funding transaction in the chain. None if the funding transaction has
10837 * not yet been confirmed and the channel fully opened.
10839 void ChannelDetails_set_short_channel_id(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
10842 * The node_id of our counterparty
10844 struct LDKPublicKey ChannelDetails_get_remote_network_id(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
10847 * The node_id of our counterparty
10849 void ChannelDetails_set_remote_network_id(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKPublicKey val);
10852 * The Features the channel counterparty provided upon last connection.
10853 * Useful for routing as it is the most up-to-date copy of the counterparty's features and
10854 * many routing-relevant features are present in the init context.
10856 struct LDKInitFeatures ChannelDetails_get_counterparty_features(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
10859 * The Features the channel counterparty provided upon last connection.
10860 * Useful for routing as it is the most up-to-date copy of the counterparty's features and
10861 * many routing-relevant features are present in the init context.
10863 void ChannelDetails_set_counterparty_features(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKInitFeatures val);
10866 * The value, in satoshis, of this channel as appears in the funding output
10868 uint64_t ChannelDetails_get_channel_value_satoshis(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
10871 * The value, in satoshis, of this channel as appears in the funding output
10873 void ChannelDetails_set_channel_value_satoshis(struct LDKChannelDetails *NONNULL_PTR this_ptr, uint64_t val);
10876 * The user_id passed in to create_channel, or 0 if the channel was inbound.
10878 uint64_t ChannelDetails_get_user_id(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
10881 * The user_id passed in to create_channel, or 0 if the channel was inbound.
10883 void ChannelDetails_set_user_id(struct LDKChannelDetails *NONNULL_PTR this_ptr, uint64_t val);
10886 * The available outbound capacity for sending HTLCs to the remote peer. This does not include
10887 * any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
10888 * available for inclusion in new outbound HTLCs). This further does not include any pending
10889 * outgoing HTLCs which are awaiting some other resolution to be sent.
10891 uint64_t ChannelDetails_get_outbound_capacity_msat(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
10894 * The available outbound capacity for sending HTLCs to the remote peer. This does not include
10895 * any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
10896 * available for inclusion in new outbound HTLCs). This further does not include any pending
10897 * outgoing HTLCs which are awaiting some other resolution to be sent.
10899 void ChannelDetails_set_outbound_capacity_msat(struct LDKChannelDetails *NONNULL_PTR this_ptr, uint64_t val);
10902 * The available inbound capacity for the remote peer to send HTLCs to us. This does not
10903 * include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
10904 * available for inclusion in new inbound HTLCs).
10905 * Note that there are some corner cases not fully handled here, so the actual available
10906 * inbound capacity may be slightly higher than this.
10908 uint64_t ChannelDetails_get_inbound_capacity_msat(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
10911 * The available inbound capacity for the remote peer to send HTLCs to us. This does not
10912 * include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
10913 * available for inclusion in new inbound HTLCs).
10914 * Note that there are some corner cases not fully handled here, so the actual available
10915 * inbound capacity may be slightly higher than this.
10917 void ChannelDetails_set_inbound_capacity_msat(struct LDKChannelDetails *NONNULL_PTR this_ptr, uint64_t val);
10920 * True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
10921 * the peer is connected, and (c) no monitor update failure is pending resolution.
10923 bool ChannelDetails_get_is_live(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
10926 * True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
10927 * the peer is connected, and (c) no monitor update failure is pending resolution.
10929 void ChannelDetails_set_is_live(struct LDKChannelDetails *NONNULL_PTR this_ptr, bool val);
10932 * Creates a copy of the ChannelDetails
10934 struct LDKChannelDetails ChannelDetails_clone(const struct LDKChannelDetails *NONNULL_PTR orig);
10937 * Frees any resources used by the PaymentSendFailure
10939 void PaymentSendFailure_free(struct LDKPaymentSendFailure this_ptr);
10942 * Creates a copy of the PaymentSendFailure
10944 struct LDKPaymentSendFailure PaymentSendFailure_clone(const struct LDKPaymentSendFailure *NONNULL_PTR orig);
10947 * Constructs a new ChannelManager to hold several channels and route between them.
10949 * This is the main \"logic hub\" for all channel-related actions, and implements
10950 * ChannelMessageHandler.
10952 * Non-proportional fees are fixed according to our risk using the provided fee estimator.
10954 * panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
10956 * Users need to notify the new ChannelManager when a new block is connected or
10957 * disconnected using its `block_connected` and `block_disconnected` methods, starting
10958 * from after `params.latest_hash`.
10960 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);
10963 * Creates a new outbound channel to the given remote node and with the given value.
10965 * user_id will be provided back as user_channel_id in FundingGenerationReady and
10966 * FundingBroadcastSafe events to allow tracking of which events correspond with which
10967 * create_channel call. Note that user_channel_id defaults to 0 for inbound channels, so you
10968 * may wish to avoid using 0 for user_id here.
10970 * If successful, will generate a SendOpenChannel message event, so you should probably poll
10971 * PeerManager::process_events afterwards.
10973 * Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat is
10974 * greater than channel_value_satoshis * 1k or channel_value_satoshis is < 1000.
10976 MUST_USE_RES struct LDKCResult_NoneAPIErrorZ ChannelManager_create_channel(const struct LDKChannelManager *NONNULL_PTR this_arg, struct LDKPublicKey their_network_key, uint64_t channel_value_satoshis, uint64_t push_msat, uint64_t user_id, struct LDKUserConfig override_config);
10979 * Gets the list of open channels, in random order. See ChannelDetail field documentation for
10980 * more information.
10982 MUST_USE_RES struct LDKCVec_ChannelDetailsZ ChannelManager_list_channels(const struct LDKChannelManager *NONNULL_PTR this_arg);
10985 * Gets the list of usable channels, in random order. Useful as an argument to
10986 * get_route to ensure non-announced channels are used.
10988 * These are guaranteed to have their is_live value set to true, see the documentation for
10989 * ChannelDetails::is_live for more info on exactly what the criteria are.
10991 MUST_USE_RES struct LDKCVec_ChannelDetailsZ ChannelManager_list_usable_channels(const struct LDKChannelManager *NONNULL_PTR this_arg);
10994 * Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
10995 * will be accepted on the given channel, and after additional timeout/the closing of all
10996 * pending HTLCs, the channel will be closed on chain.
10998 * May generate a SendShutdown message event on success, which should be relayed.
11000 MUST_USE_RES struct LDKCResult_NoneAPIErrorZ ChannelManager_close_channel(const struct LDKChannelManager *NONNULL_PTR this_arg, const uint8_t (*channel_id)[32]);
11003 * Force closes a channel, immediately broadcasting the latest local commitment transaction to
11004 * the chain and rejecting new HTLCs on the given channel. Fails if channel_id is unknown to the manager.
11006 MUST_USE_RES struct LDKCResult_NoneAPIErrorZ ChannelManager_force_close_channel(const struct LDKChannelManager *NONNULL_PTR this_arg, const uint8_t (*channel_id)[32]);
11009 * Force close all channels, immediately broadcasting the latest local commitment transaction
11010 * for each to the chain and rejecting new HTLCs on each.
11012 void ChannelManager_force_close_all_channels(const struct LDKChannelManager *NONNULL_PTR this_arg);
11015 * Sends a payment along a given route.
11017 * Value parameters are provided via the last hop in route, see documentation for RouteHop
11018 * fields for more info.
11020 * Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
11021 * payment), we don't do anything to stop you! We always try to ensure that if the provided
11022 * next hop knows the preimage to payment_hash they can claim an additional amount as
11023 * specified in the last hop in the route! Thus, you should probably do your own
11024 * payment_preimage tracking (which you should already be doing as they represent \"proof of
11025 * payment\") and prevent double-sends yourself.
11027 * May generate SendHTLCs message(s) event on success, which should be relayed.
11029 * Each path may have a different return value, and PaymentSendValue may return a Vec with
11030 * each entry matching the corresponding-index entry in the route paths, see
11031 * PaymentSendFailure for more info.
11033 * In general, a path may raise:
11034 * * APIError::RouteError when an invalid route or forwarding parameter (cltv_delta, fee,
11035 * node public key) is specified.
11036 * * APIError::ChannelUnavailable if the next-hop channel is not available for updates
11037 * (including due to previous monitor update failure or new permanent monitor update
11039 * * APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
11040 * relevant updates.
11042 * Note that depending on the type of the PaymentSendFailure the HTLC may have been
11043 * irrevocably committed to on our end. In such a case, do NOT retry the payment with a
11044 * different route unless you intend to pay twice!
11046 * payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
11047 * the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
11048 * newer nodes, it will be provided to you in the invoice. If you do not have one, the Route
11049 * must not contain multiple paths as multi-path payments require a recipient-provided
11051 * If a payment_secret *is* provided, we assume that the invoice had the payment_secret feature
11052 * bit set (either as required or as available). If multiple paths are present in the Route,
11053 * we assume the invoice had the basic_mpp feature set.
11055 MUST_USE_RES struct LDKCResult_NonePaymentSendFailureZ ChannelManager_send_payment(const struct LDKChannelManager *NONNULL_PTR this_arg, const struct LDKRoute *NONNULL_PTR route, struct LDKThirtyTwoBytes payment_hash, struct LDKThirtyTwoBytes payment_secret);
11058 * Call this upon creation of a funding transaction for the given channel.
11060 * Note that ALL inputs in the transaction pointed to by funding_txo MUST spend SegWit outputs
11061 * or your counterparty can steal your funds!
11063 * Panics if a funding transaction has already been provided for this channel.
11065 * May panic if the funding_txo is duplicative with some other channel (note that this should
11066 * be trivially prevented by using unique funding transaction keys per-channel).
11068 void ChannelManager_funding_transaction_generated(const struct LDKChannelManager *NONNULL_PTR this_arg, const uint8_t (*temporary_channel_id)[32], struct LDKOutPoint funding_txo);
11071 * Generates a signed node_announcement from the given arguments and creates a
11072 * BroadcastNodeAnnouncement event. Note that such messages will be ignored unless peers have
11073 * seen a channel_announcement from us (ie unless we have public channels open).
11075 * RGB is a node \"color\" and alias is a printable human-readable string to describe this node
11076 * to humans. They carry no in-protocol meaning.
11078 * addresses represent the set (possibly empty) of socket addresses on which this node accepts
11079 * incoming connections. These will be broadcast to the network, publicly tying these
11080 * addresses together. If you wish to preserve user privacy, addresses should likely contain
11081 * only Tor Onion addresses.
11083 * Panics if addresses is absurdly large (more than 500).
11085 void ChannelManager_broadcast_node_announcement(const struct LDKChannelManager *NONNULL_PTR this_arg, struct LDKThreeBytes rgb, struct LDKThirtyTwoBytes alias, struct LDKCVec_NetAddressZ addresses);
11088 * Processes HTLCs which are pending waiting on random forward delay.
11090 * Should only really ever be called in response to a PendingHTLCsForwardable event.
11091 * Will likely generate further events.
11093 void ChannelManager_process_pending_htlc_forwards(const struct LDKChannelManager *NONNULL_PTR this_arg);
11096 * If a peer is disconnected we mark any channels with that peer as 'disabled'.
11097 * After some time, if channels are still disabled we need to broadcast a ChannelUpdate
11098 * to inform the network about the uselessness of these channels.
11100 * This method handles all the details, and must be called roughly once per minute.
11102 * Note that in some rare cases this may generate a `chain::Watch::update_channel` call.
11104 void ChannelManager_timer_chan_freshness_every_min(const struct LDKChannelManager *NONNULL_PTR this_arg);
11107 * Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
11108 * after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
11109 * along the path (including in our own channel on which we received it).
11110 * Returns false if no payment was found to fail backwards, true if the process of failing the
11111 * HTLC backwards has been started.
11113 MUST_USE_RES bool ChannelManager_fail_htlc_backwards(const struct LDKChannelManager *NONNULL_PTR this_arg, const uint8_t (*payment_hash)[32], struct LDKThirtyTwoBytes payment_secret);
11116 * Provides a payment preimage in response to a PaymentReceived event, returning true and
11117 * generating message events for the net layer to claim the payment, if possible. Thus, you
11118 * should probably kick the net layer to go send messages if this returns true!
11120 * You must specify the expected amounts for this HTLC, and we will only claim HTLCs
11121 * available within a few percent of the expected amount. This is critical for several
11122 * reasons : a) it avoids providing senders with `proof-of-payment` (in the form of the
11123 * payment_preimage without having provided the full value and b) it avoids certain
11124 * privacy-breaking recipient-probing attacks which may reveal payment activity to
11125 * motivated attackers.
11127 * Note that the privacy concerns in (b) are not relevant in payments with a payment_secret
11128 * set. Thus, for such payments we will claim any payments which do not under-pay.
11130 * May panic if called except in response to a PaymentReceived event.
11132 MUST_USE_RES bool ChannelManager_claim_funds(const struct LDKChannelManager *NONNULL_PTR this_arg, struct LDKThirtyTwoBytes payment_preimage, struct LDKThirtyTwoBytes payment_secret, uint64_t expected_amount);
11135 * Gets the node_id held by this ChannelManager
11137 MUST_USE_RES struct LDKPublicKey ChannelManager_get_our_node_id(const struct LDKChannelManager *NONNULL_PTR this_arg);
11140 * Restores a single, given channel to normal operation after a
11141 * ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
11144 * All ChannelMonitor updates up to and including highest_applied_update_id must have been
11145 * fully committed in every copy of the given channels' ChannelMonitors.
11147 * Note that there is no effect to calling with a highest_applied_update_id other than the
11148 * current latest ChannelMonitorUpdate and one call to this function after multiple
11149 * ChannelMonitorUpdateErr::TemporaryFailures is fine. The highest_applied_update_id field
11150 * exists largely only to prevent races between this and concurrent update_monitor calls.
11152 * Thus, the anticipated use is, at a high level:
11153 * 1) You register a chain::Watch with this ChannelManager,
11154 * 2) it stores each update to disk, and begins updating any remote (eg watchtower) copies of
11155 * said ChannelMonitors as it can, returning ChannelMonitorUpdateErr::TemporaryFailures
11156 * any time it cannot do so instantly,
11157 * 3) update(s) are applied to each remote copy of a ChannelMonitor,
11158 * 4) once all remote copies are updated, you call this function with the update_id that
11159 * completed, and once it is the latest the Channel will be re-enabled.
11161 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);
11164 * Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
11165 * This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
11167 struct LDKMessageSendEventsProvider ChannelManager_as_MessageSendEventsProvider(const struct LDKChannelManager *NONNULL_PTR this_arg);
11170 * Constructs a new EventsProvider which calls the relevant methods on this_arg.
11171 * This copies the `inner` pointer in this_arg and thus the returned EventsProvider must be freed before this_arg is
11173 struct LDKEventsProvider ChannelManager_as_EventsProvider(const struct LDKChannelManager *NONNULL_PTR this_arg);
11176 * Constructs a new Listen which calls the relevant methods on this_arg.
11177 * This copies the `inner` pointer in this_arg and thus the returned Listen must be freed before this_arg is
11179 struct LDKListen ChannelManager_as_Listen(const struct LDKChannelManager *NONNULL_PTR this_arg);
11182 * Updates channel state based on transactions seen in a connected block.
11184 void ChannelManager_block_connected(const struct LDKChannelManager *NONNULL_PTR this_arg, const uint8_t (*header)[80], struct LDKCVec_C2Tuple_usizeTransactionZZ txdata, uint32_t height);
11187 * Updates channel state based on a disconnected block.
11189 * If necessary, the channel may be force-closed without letting the counterparty participate
11192 void ChannelManager_block_disconnected(const struct LDKChannelManager *NONNULL_PTR this_arg, const uint8_t (*header)[80]);
11195 * Blocks until ChannelManager needs to be persisted or a timeout is reached. It returns a bool
11196 * indicating whether persistence is necessary. Only one listener on
11197 * `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
11199 * Note that the feature `allow_wallclock_use` must be enabled to use this function.
11201 MUST_USE_RES bool ChannelManager_await_persistable_update_timeout(const struct LDKChannelManager *NONNULL_PTR this_arg, uint64_t max_wait);
11204 * Blocks until ChannelManager needs to be persisted. Only one listener on
11205 * `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
11208 void ChannelManager_await_persistable_update(const struct LDKChannelManager *NONNULL_PTR this_arg);
11211 * Constructs a new ChannelMessageHandler which calls the relevant methods on this_arg.
11212 * This copies the `inner` pointer in this_arg and thus the returned ChannelMessageHandler must be freed before this_arg is
11214 struct LDKChannelMessageHandler ChannelManager_as_ChannelMessageHandler(const struct LDKChannelManager *NONNULL_PTR this_arg);
11217 * Serialize the ChannelManager object into a byte array which can be read by ChannelManager_read
11219 struct LDKCVec_u8Z ChannelManager_write(const struct LDKChannelManager *NONNULL_PTR obj);
11222 * Frees any resources used by the ChannelManagerReadArgs, if is_owned is set and inner is non-NULL.
11224 void ChannelManagerReadArgs_free(struct LDKChannelManagerReadArgs this_obj);
11227 * The keys provider which will give us relevant keys. Some keys will be loaded during
11228 * deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
11231 const struct LDKKeysInterface *ChannelManagerReadArgs_get_keys_manager(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
11234 * The keys provider which will give us relevant keys. Some keys will be loaded during
11235 * deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
11238 void ChannelManagerReadArgs_set_keys_manager(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKKeysInterface val);
11241 * The fee_estimator for use in the ChannelManager in the future.
11243 * No calls to the FeeEstimator will be made during deserialization.
11245 const struct LDKFeeEstimator *ChannelManagerReadArgs_get_fee_estimator(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
11248 * The fee_estimator for use in the ChannelManager in the future.
11250 * No calls to the FeeEstimator will be made during deserialization.
11252 void ChannelManagerReadArgs_set_fee_estimator(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKFeeEstimator val);
11255 * The chain::Watch for use in the ChannelManager in the future.
11257 * No calls to the chain::Watch will be made during deserialization. It is assumed that
11258 * you have deserialized ChannelMonitors separately and will add them to your
11259 * chain::Watch after deserializing this ChannelManager.
11261 const struct LDKWatch *ChannelManagerReadArgs_get_chain_monitor(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
11264 * The chain::Watch for use in the ChannelManager in the future.
11266 * No calls to the chain::Watch will be made during deserialization. It is assumed that
11267 * you have deserialized ChannelMonitors separately and will add them to your
11268 * chain::Watch after deserializing this ChannelManager.
11270 void ChannelManagerReadArgs_set_chain_monitor(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKWatch val);
11273 * The BroadcasterInterface which will be used in the ChannelManager in the future and may be
11274 * used to broadcast the latest local commitment transactions of channels which must be
11275 * force-closed during deserialization.
11277 const struct LDKBroadcasterInterface *ChannelManagerReadArgs_get_tx_broadcaster(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
11280 * The BroadcasterInterface which will be used in the ChannelManager in the future and may be
11281 * used to broadcast the latest local commitment transactions of channels which must be
11282 * force-closed during deserialization.
11284 void ChannelManagerReadArgs_set_tx_broadcaster(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKBroadcasterInterface val);
11287 * The Logger for use in the ChannelManager and which may be used to log information during
11290 const struct LDKLogger *ChannelManagerReadArgs_get_logger(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
11293 * The Logger for use in the ChannelManager and which may be used to log information during
11296 void ChannelManagerReadArgs_set_logger(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKLogger val);
11299 * Default settings used for new channels. Any existing channels will continue to use the
11300 * runtime settings which were stored when the ChannelManager was serialized.
11302 struct LDKUserConfig ChannelManagerReadArgs_get_default_config(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
11305 * Default settings used for new channels. Any existing channels will continue to use the
11306 * runtime settings which were stored when the ChannelManager was serialized.
11308 void ChannelManagerReadArgs_set_default_config(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKUserConfig val);
11311 * Simple utility function to create a ChannelManagerReadArgs which creates the monitor
11312 * HashMap for you. This is primarily useful for C bindings where it is not practical to
11313 * populate a HashMap directly from C.
11315 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);
11318 * Read a C2Tuple_BlockHashChannelManagerZ from a byte array, created by C2Tuple_BlockHashChannelManagerZ_write
11320 struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ C2Tuple_BlockHashChannelManagerZ_read(struct LDKu8slice ser, struct LDKChannelManagerReadArgs arg);
11323 * Frees any resources used by the DecodeError, if is_owned is set and inner is non-NULL.
11325 void DecodeError_free(struct LDKDecodeError this_obj);
11328 * Creates a copy of the DecodeError
11330 struct LDKDecodeError DecodeError_clone(const struct LDKDecodeError *NONNULL_PTR orig);
11333 * Frees any resources used by the Init, if is_owned is set and inner is non-NULL.
11335 void Init_free(struct LDKInit this_obj);
11338 * The relevant features which the sender supports
11340 struct LDKInitFeatures Init_get_features(const struct LDKInit *NONNULL_PTR this_ptr);
11343 * The relevant features which the sender supports
11345 void Init_set_features(struct LDKInit *NONNULL_PTR this_ptr, struct LDKInitFeatures val);
11348 * Constructs a new Init given each field
11350 MUST_USE_RES struct LDKInit Init_new(struct LDKInitFeatures features_arg);
11353 * Creates a copy of the Init
11355 struct LDKInit Init_clone(const struct LDKInit *NONNULL_PTR orig);
11358 * Frees any resources used by the ErrorMessage, if is_owned is set and inner is non-NULL.
11360 void ErrorMessage_free(struct LDKErrorMessage this_obj);
11363 * The channel ID involved in the error
11365 const uint8_t (*ErrorMessage_get_channel_id(const struct LDKErrorMessage *NONNULL_PTR this_ptr))[32];
11368 * The channel ID involved in the error
11370 void ErrorMessage_set_channel_id(struct LDKErrorMessage *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
11373 * A possibly human-readable error description.
11374 * The string should be sanitized before it is used (e.g. emitted to logs
11375 * or printed to stdout). Otherwise, a well crafted error message may trigger a security
11376 * vulnerability in the terminal emulator or the logging subsystem.
11378 struct LDKStr ErrorMessage_get_data(const struct LDKErrorMessage *NONNULL_PTR this_ptr);
11381 * A possibly human-readable error description.
11382 * The string should be sanitized before it is used (e.g. emitted to logs
11383 * or printed to stdout). Otherwise, a well crafted error message may trigger a security
11384 * vulnerability in the terminal emulator or the logging subsystem.
11386 void ErrorMessage_set_data(struct LDKErrorMessage *NONNULL_PTR this_ptr, struct LDKCVec_u8Z val);
11389 * Constructs a new ErrorMessage given each field
11391 MUST_USE_RES struct LDKErrorMessage ErrorMessage_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKCVec_u8Z data_arg);
11394 * Creates a copy of the ErrorMessage
11396 struct LDKErrorMessage ErrorMessage_clone(const struct LDKErrorMessage *NONNULL_PTR orig);
11399 * Frees any resources used by the Ping, if is_owned is set and inner is non-NULL.
11401 void Ping_free(struct LDKPing this_obj);
11404 * The desired response length
11406 uint16_t Ping_get_ponglen(const struct LDKPing *NONNULL_PTR this_ptr);
11409 * The desired response length
11411 void Ping_set_ponglen(struct LDKPing *NONNULL_PTR this_ptr, uint16_t val);
11414 * The ping packet size.
11415 * This field is not sent on the wire. byteslen zeros are sent.
11417 uint16_t Ping_get_byteslen(const struct LDKPing *NONNULL_PTR this_ptr);
11420 * The ping packet size.
11421 * This field is not sent on the wire. byteslen zeros are sent.
11423 void Ping_set_byteslen(struct LDKPing *NONNULL_PTR this_ptr, uint16_t val);
11426 * Constructs a new Ping given each field
11428 MUST_USE_RES struct LDKPing Ping_new(uint16_t ponglen_arg, uint16_t byteslen_arg);
11431 * Creates a copy of the Ping
11433 struct LDKPing Ping_clone(const struct LDKPing *NONNULL_PTR orig);
11436 * Frees any resources used by the Pong, if is_owned is set and inner is non-NULL.
11438 void Pong_free(struct LDKPong this_obj);
11441 * The pong packet size.
11442 * This field is not sent on the wire. byteslen zeros are sent.
11444 uint16_t Pong_get_byteslen(const struct LDKPong *NONNULL_PTR this_ptr);
11447 * The pong packet size.
11448 * This field is not sent on the wire. byteslen zeros are sent.
11450 void Pong_set_byteslen(struct LDKPong *NONNULL_PTR this_ptr, uint16_t val);
11453 * Constructs a new Pong given each field
11455 MUST_USE_RES struct LDKPong Pong_new(uint16_t byteslen_arg);
11458 * Creates a copy of the Pong
11460 struct LDKPong Pong_clone(const struct LDKPong *NONNULL_PTR orig);
11463 * Frees any resources used by the OpenChannel, if is_owned is set and inner is non-NULL.
11465 void OpenChannel_free(struct LDKOpenChannel this_obj);
11468 * The genesis hash of the blockchain where the channel is to be opened
11470 const uint8_t (*OpenChannel_get_chain_hash(const struct LDKOpenChannel *NONNULL_PTR this_ptr))[32];
11473 * The genesis hash of the blockchain where the channel is to be opened
11475 void OpenChannel_set_chain_hash(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
11478 * A temporary channel ID, until the funding outpoint is announced
11480 const uint8_t (*OpenChannel_get_temporary_channel_id(const struct LDKOpenChannel *NONNULL_PTR this_ptr))[32];
11483 * A temporary channel ID, until the funding outpoint is announced
11485 void OpenChannel_set_temporary_channel_id(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
11488 * The channel value
11490 uint64_t OpenChannel_get_funding_satoshis(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
11493 * The channel value
11495 void OpenChannel_set_funding_satoshis(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
11498 * The amount to push to the counterparty as part of the open, in milli-satoshi
11500 uint64_t OpenChannel_get_push_msat(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
11503 * The amount to push to the counterparty as part of the open, in milli-satoshi
11505 void OpenChannel_set_push_msat(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
11508 * The threshold below which outputs on transactions broadcast by sender will be omitted
11510 uint64_t OpenChannel_get_dust_limit_satoshis(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
11513 * The threshold below which outputs on transactions broadcast by sender will be omitted
11515 void OpenChannel_set_dust_limit_satoshis(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
11518 * The maximum inbound HTLC value in flight towards sender, in milli-satoshi
11520 uint64_t OpenChannel_get_max_htlc_value_in_flight_msat(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
11523 * The maximum inbound HTLC value in flight towards sender, in milli-satoshi
11525 void OpenChannel_set_max_htlc_value_in_flight_msat(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
11528 * The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
11530 uint64_t OpenChannel_get_channel_reserve_satoshis(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
11533 * The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
11535 void OpenChannel_set_channel_reserve_satoshis(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
11538 * The minimum HTLC size incoming to sender, in milli-satoshi
11540 uint64_t OpenChannel_get_htlc_minimum_msat(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
11543 * The minimum HTLC size incoming to sender, in milli-satoshi
11545 void OpenChannel_set_htlc_minimum_msat(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
11548 * The feerate per 1000-weight of sender generated transactions, until updated by update_fee
11550 uint32_t OpenChannel_get_feerate_per_kw(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
11553 * The feerate per 1000-weight of sender generated transactions, until updated by update_fee
11555 void OpenChannel_set_feerate_per_kw(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint32_t val);
11558 * The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
11560 uint16_t OpenChannel_get_to_self_delay(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
11563 * The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
11565 void OpenChannel_set_to_self_delay(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint16_t val);
11568 * The maximum number of inbound HTLCs towards sender
11570 uint16_t OpenChannel_get_max_accepted_htlcs(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
11573 * The maximum number of inbound HTLCs towards sender
11575 void OpenChannel_set_max_accepted_htlcs(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint16_t val);
11578 * The sender's key controlling the funding transaction
11580 struct LDKPublicKey OpenChannel_get_funding_pubkey(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
11583 * The sender's key controlling the funding transaction
11585 void OpenChannel_set_funding_pubkey(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
11588 * Used to derive a revocation key for transactions broadcast by counterparty
11590 struct LDKPublicKey OpenChannel_get_revocation_basepoint(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
11593 * Used to derive a revocation key for transactions broadcast by counterparty
11595 void OpenChannel_set_revocation_basepoint(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
11598 * A payment key to sender for transactions broadcast by counterparty
11600 struct LDKPublicKey OpenChannel_get_payment_point(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
11603 * A payment key to sender for transactions broadcast by counterparty
11605 void OpenChannel_set_payment_point(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
11608 * Used to derive a payment key to sender for transactions broadcast by sender
11610 struct LDKPublicKey OpenChannel_get_delayed_payment_basepoint(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
11613 * Used to derive a payment key to sender for transactions broadcast by sender
11615 void OpenChannel_set_delayed_payment_basepoint(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
11618 * Used to derive an HTLC payment key to sender
11620 struct LDKPublicKey OpenChannel_get_htlc_basepoint(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
11623 * Used to derive an HTLC payment key to sender
11625 void OpenChannel_set_htlc_basepoint(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
11628 * The first to-be-broadcast-by-sender transaction's per commitment point
11630 struct LDKPublicKey OpenChannel_get_first_per_commitment_point(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
11633 * The first to-be-broadcast-by-sender transaction's per commitment point
11635 void OpenChannel_set_first_per_commitment_point(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
11640 uint8_t OpenChannel_get_channel_flags(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
11645 void OpenChannel_set_channel_flags(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint8_t val);
11648 * Creates a copy of the OpenChannel
11650 struct LDKOpenChannel OpenChannel_clone(const struct LDKOpenChannel *NONNULL_PTR orig);
11653 * Frees any resources used by the AcceptChannel, if is_owned is set and inner is non-NULL.
11655 void AcceptChannel_free(struct LDKAcceptChannel this_obj);
11658 * A temporary channel ID, until the funding outpoint is announced
11660 const uint8_t (*AcceptChannel_get_temporary_channel_id(const struct LDKAcceptChannel *NONNULL_PTR this_ptr))[32];
11663 * A temporary channel ID, until the funding outpoint is announced
11665 void AcceptChannel_set_temporary_channel_id(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
11668 * The threshold below which outputs on transactions broadcast by sender will be omitted
11670 uint64_t AcceptChannel_get_dust_limit_satoshis(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
11673 * The threshold below which outputs on transactions broadcast by sender will be omitted
11675 void AcceptChannel_set_dust_limit_satoshis(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint64_t val);
11678 * The maximum inbound HTLC value in flight towards sender, in milli-satoshi
11680 uint64_t AcceptChannel_get_max_htlc_value_in_flight_msat(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
11683 * The maximum inbound HTLC value in flight towards sender, in milli-satoshi
11685 void AcceptChannel_set_max_htlc_value_in_flight_msat(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint64_t val);
11688 * The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
11690 uint64_t AcceptChannel_get_channel_reserve_satoshis(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
11693 * The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
11695 void AcceptChannel_set_channel_reserve_satoshis(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint64_t val);
11698 * The minimum HTLC size incoming to sender, in milli-satoshi
11700 uint64_t AcceptChannel_get_htlc_minimum_msat(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
11703 * The minimum HTLC size incoming to sender, in milli-satoshi
11705 void AcceptChannel_set_htlc_minimum_msat(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint64_t val);
11708 * Minimum depth of the funding transaction before the channel is considered open
11710 uint32_t AcceptChannel_get_minimum_depth(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
11713 * Minimum depth of the funding transaction before the channel is considered open
11715 void AcceptChannel_set_minimum_depth(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint32_t val);
11718 * The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
11720 uint16_t AcceptChannel_get_to_self_delay(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
11723 * The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
11725 void AcceptChannel_set_to_self_delay(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint16_t val);
11728 * The maximum number of inbound HTLCs towards sender
11730 uint16_t AcceptChannel_get_max_accepted_htlcs(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
11733 * The maximum number of inbound HTLCs towards sender
11735 void AcceptChannel_set_max_accepted_htlcs(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint16_t val);
11738 * The sender's key controlling the funding transaction
11740 struct LDKPublicKey AcceptChannel_get_funding_pubkey(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
11743 * The sender's key controlling the funding transaction
11745 void AcceptChannel_set_funding_pubkey(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
11748 * Used to derive a revocation key for transactions broadcast by counterparty
11750 struct LDKPublicKey AcceptChannel_get_revocation_basepoint(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
11753 * Used to derive a revocation key for transactions broadcast by counterparty
11755 void AcceptChannel_set_revocation_basepoint(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
11758 * A payment key to sender for transactions broadcast by counterparty
11760 struct LDKPublicKey AcceptChannel_get_payment_point(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
11763 * A payment key to sender for transactions broadcast by counterparty
11765 void AcceptChannel_set_payment_point(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
11768 * Used to derive a payment key to sender for transactions broadcast by sender
11770 struct LDKPublicKey AcceptChannel_get_delayed_payment_basepoint(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
11773 * Used to derive a payment key to sender for transactions broadcast by sender
11775 void AcceptChannel_set_delayed_payment_basepoint(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
11778 * Used to derive an HTLC payment key to sender for transactions broadcast by counterparty
11780 struct LDKPublicKey AcceptChannel_get_htlc_basepoint(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
11783 * Used to derive an HTLC payment key to sender for transactions broadcast by counterparty
11785 void AcceptChannel_set_htlc_basepoint(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
11788 * The first to-be-broadcast-by-sender transaction's per commitment point
11790 struct LDKPublicKey AcceptChannel_get_first_per_commitment_point(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
11793 * The first to-be-broadcast-by-sender transaction's per commitment point
11795 void AcceptChannel_set_first_per_commitment_point(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
11798 * Creates a copy of the AcceptChannel
11800 struct LDKAcceptChannel AcceptChannel_clone(const struct LDKAcceptChannel *NONNULL_PTR orig);
11803 * Frees any resources used by the FundingCreated, if is_owned is set and inner is non-NULL.
11805 void FundingCreated_free(struct LDKFundingCreated this_obj);
11808 * A temporary channel ID, until the funding is established
11810 const uint8_t (*FundingCreated_get_temporary_channel_id(const struct LDKFundingCreated *NONNULL_PTR this_ptr))[32];
11813 * A temporary channel ID, until the funding is established
11815 void FundingCreated_set_temporary_channel_id(struct LDKFundingCreated *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
11818 * The funding transaction ID
11820 const uint8_t (*FundingCreated_get_funding_txid(const struct LDKFundingCreated *NONNULL_PTR this_ptr))[32];
11823 * The funding transaction ID
11825 void FundingCreated_set_funding_txid(struct LDKFundingCreated *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
11828 * The specific output index funding this channel
11830 uint16_t FundingCreated_get_funding_output_index(const struct LDKFundingCreated *NONNULL_PTR this_ptr);
11833 * The specific output index funding this channel
11835 void FundingCreated_set_funding_output_index(struct LDKFundingCreated *NONNULL_PTR this_ptr, uint16_t val);
11838 * The signature of the channel initiator (funder) on the funding transaction
11840 struct LDKSignature FundingCreated_get_signature(const struct LDKFundingCreated *NONNULL_PTR this_ptr);
11843 * The signature of the channel initiator (funder) on the funding transaction
11845 void FundingCreated_set_signature(struct LDKFundingCreated *NONNULL_PTR this_ptr, struct LDKSignature val);
11848 * Constructs a new FundingCreated given each field
11850 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);
11853 * Creates a copy of the FundingCreated
11855 struct LDKFundingCreated FundingCreated_clone(const struct LDKFundingCreated *NONNULL_PTR orig);
11858 * Frees any resources used by the FundingSigned, if is_owned is set and inner is non-NULL.
11860 void FundingSigned_free(struct LDKFundingSigned this_obj);
11865 const uint8_t (*FundingSigned_get_channel_id(const struct LDKFundingSigned *NONNULL_PTR this_ptr))[32];
11870 void FundingSigned_set_channel_id(struct LDKFundingSigned *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
11873 * The signature of the channel acceptor (fundee) on the funding transaction
11875 struct LDKSignature FundingSigned_get_signature(const struct LDKFundingSigned *NONNULL_PTR this_ptr);
11878 * The signature of the channel acceptor (fundee) on the funding transaction
11880 void FundingSigned_set_signature(struct LDKFundingSigned *NONNULL_PTR this_ptr, struct LDKSignature val);
11883 * Constructs a new FundingSigned given each field
11885 MUST_USE_RES struct LDKFundingSigned FundingSigned_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKSignature signature_arg);
11888 * Creates a copy of the FundingSigned
11890 struct LDKFundingSigned FundingSigned_clone(const struct LDKFundingSigned *NONNULL_PTR orig);
11893 * Frees any resources used by the FundingLocked, if is_owned is set and inner is non-NULL.
11895 void FundingLocked_free(struct LDKFundingLocked this_obj);
11900 const uint8_t (*FundingLocked_get_channel_id(const struct LDKFundingLocked *NONNULL_PTR this_ptr))[32];
11905 void FundingLocked_set_channel_id(struct LDKFundingLocked *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
11908 * The per-commitment point of the second commitment transaction
11910 struct LDKPublicKey FundingLocked_get_next_per_commitment_point(const struct LDKFundingLocked *NONNULL_PTR this_ptr);
11913 * The per-commitment point of the second commitment transaction
11915 void FundingLocked_set_next_per_commitment_point(struct LDKFundingLocked *NONNULL_PTR this_ptr, struct LDKPublicKey val);
11918 * Constructs a new FundingLocked given each field
11920 MUST_USE_RES struct LDKFundingLocked FundingLocked_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKPublicKey next_per_commitment_point_arg);
11923 * Creates a copy of the FundingLocked
11925 struct LDKFundingLocked FundingLocked_clone(const struct LDKFundingLocked *NONNULL_PTR orig);
11928 * Frees any resources used by the Shutdown, if is_owned is set and inner is non-NULL.
11930 void Shutdown_free(struct LDKShutdown this_obj);
11935 const uint8_t (*Shutdown_get_channel_id(const struct LDKShutdown *NONNULL_PTR this_ptr))[32];
11940 void Shutdown_set_channel_id(struct LDKShutdown *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
11943 * The destination of this peer's funds on closing.
11944 * Must be in one of these forms: p2pkh, p2sh, p2wpkh, p2wsh.
11946 struct LDKu8slice Shutdown_get_scriptpubkey(const struct LDKShutdown *NONNULL_PTR this_ptr);
11949 * The destination of this peer's funds on closing.
11950 * Must be in one of these forms: p2pkh, p2sh, p2wpkh, p2wsh.
11952 void Shutdown_set_scriptpubkey(struct LDKShutdown *NONNULL_PTR this_ptr, struct LDKCVec_u8Z val);
11955 * Constructs a new Shutdown given each field
11957 MUST_USE_RES struct LDKShutdown Shutdown_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKCVec_u8Z scriptpubkey_arg);
11960 * Creates a copy of the Shutdown
11962 struct LDKShutdown Shutdown_clone(const struct LDKShutdown *NONNULL_PTR orig);
11965 * Frees any resources used by the ClosingSigned, if is_owned is set and inner is non-NULL.
11967 void ClosingSigned_free(struct LDKClosingSigned this_obj);
11972 const uint8_t (*ClosingSigned_get_channel_id(const struct LDKClosingSigned *NONNULL_PTR this_ptr))[32];
11977 void ClosingSigned_set_channel_id(struct LDKClosingSigned *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
11980 * The proposed total fee for the closing transaction
11982 uint64_t ClosingSigned_get_fee_satoshis(const struct LDKClosingSigned *NONNULL_PTR this_ptr);
11985 * The proposed total fee for the closing transaction
11987 void ClosingSigned_set_fee_satoshis(struct LDKClosingSigned *NONNULL_PTR this_ptr, uint64_t val);
11990 * A signature on the closing transaction
11992 struct LDKSignature ClosingSigned_get_signature(const struct LDKClosingSigned *NONNULL_PTR this_ptr);
11995 * A signature on the closing transaction
11997 void ClosingSigned_set_signature(struct LDKClosingSigned *NONNULL_PTR this_ptr, struct LDKSignature val);
12000 * Constructs a new ClosingSigned given each field
12002 MUST_USE_RES struct LDKClosingSigned ClosingSigned_new(struct LDKThirtyTwoBytes channel_id_arg, uint64_t fee_satoshis_arg, struct LDKSignature signature_arg);
12005 * Creates a copy of the ClosingSigned
12007 struct LDKClosingSigned ClosingSigned_clone(const struct LDKClosingSigned *NONNULL_PTR orig);
12010 * Frees any resources used by the UpdateAddHTLC, if is_owned is set and inner is non-NULL.
12012 void UpdateAddHTLC_free(struct LDKUpdateAddHTLC this_obj);
12017 const uint8_t (*UpdateAddHTLC_get_channel_id(const struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr))[32];
12022 void UpdateAddHTLC_set_channel_id(struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
12027 uint64_t UpdateAddHTLC_get_htlc_id(const struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr);
12032 void UpdateAddHTLC_set_htlc_id(struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr, uint64_t val);
12035 * The HTLC value in milli-satoshi
12037 uint64_t UpdateAddHTLC_get_amount_msat(const struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr);
12040 * The HTLC value in milli-satoshi
12042 void UpdateAddHTLC_set_amount_msat(struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr, uint64_t val);
12045 * The payment hash, the pre-image of which controls HTLC redemption
12047 const uint8_t (*UpdateAddHTLC_get_payment_hash(const struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr))[32];
12050 * The payment hash, the pre-image of which controls HTLC redemption
12052 void UpdateAddHTLC_set_payment_hash(struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
12055 * The expiry height of the HTLC
12057 uint32_t UpdateAddHTLC_get_cltv_expiry(const struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr);
12060 * The expiry height of the HTLC
12062 void UpdateAddHTLC_set_cltv_expiry(struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr, uint32_t val);
12065 * Creates a copy of the UpdateAddHTLC
12067 struct LDKUpdateAddHTLC UpdateAddHTLC_clone(const struct LDKUpdateAddHTLC *NONNULL_PTR orig);
12070 * Frees any resources used by the UpdateFulfillHTLC, if is_owned is set and inner is non-NULL.
12072 void UpdateFulfillHTLC_free(struct LDKUpdateFulfillHTLC this_obj);
12077 const uint8_t (*UpdateFulfillHTLC_get_channel_id(const struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr))[32];
12082 void UpdateFulfillHTLC_set_channel_id(struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
12087 uint64_t UpdateFulfillHTLC_get_htlc_id(const struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr);
12092 void UpdateFulfillHTLC_set_htlc_id(struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr, uint64_t val);
12095 * The pre-image of the payment hash, allowing HTLC redemption
12097 const uint8_t (*UpdateFulfillHTLC_get_payment_preimage(const struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr))[32];
12100 * The pre-image of the payment hash, allowing HTLC redemption
12102 void UpdateFulfillHTLC_set_payment_preimage(struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
12105 * Constructs a new UpdateFulfillHTLC given each field
12107 MUST_USE_RES struct LDKUpdateFulfillHTLC UpdateFulfillHTLC_new(struct LDKThirtyTwoBytes channel_id_arg, uint64_t htlc_id_arg, struct LDKThirtyTwoBytes payment_preimage_arg);
12110 * Creates a copy of the UpdateFulfillHTLC
12112 struct LDKUpdateFulfillHTLC UpdateFulfillHTLC_clone(const struct LDKUpdateFulfillHTLC *NONNULL_PTR orig);
12115 * Frees any resources used by the UpdateFailHTLC, if is_owned is set and inner is non-NULL.
12117 void UpdateFailHTLC_free(struct LDKUpdateFailHTLC this_obj);
12122 const uint8_t (*UpdateFailHTLC_get_channel_id(const struct LDKUpdateFailHTLC *NONNULL_PTR this_ptr))[32];
12127 void UpdateFailHTLC_set_channel_id(struct LDKUpdateFailHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
12132 uint64_t UpdateFailHTLC_get_htlc_id(const struct LDKUpdateFailHTLC *NONNULL_PTR this_ptr);
12137 void UpdateFailHTLC_set_htlc_id(struct LDKUpdateFailHTLC *NONNULL_PTR this_ptr, uint64_t val);
12140 * Creates a copy of the UpdateFailHTLC
12142 struct LDKUpdateFailHTLC UpdateFailHTLC_clone(const struct LDKUpdateFailHTLC *NONNULL_PTR orig);
12145 * Frees any resources used by the UpdateFailMalformedHTLC, if is_owned is set and inner is non-NULL.
12147 void UpdateFailMalformedHTLC_free(struct LDKUpdateFailMalformedHTLC this_obj);
12152 const uint8_t (*UpdateFailMalformedHTLC_get_channel_id(const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr))[32];
12157 void UpdateFailMalformedHTLC_set_channel_id(struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
12162 uint64_t UpdateFailMalformedHTLC_get_htlc_id(const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr);
12167 void UpdateFailMalformedHTLC_set_htlc_id(struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr, uint64_t val);
12172 uint16_t UpdateFailMalformedHTLC_get_failure_code(const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr);
12177 void UpdateFailMalformedHTLC_set_failure_code(struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr, uint16_t val);
12180 * Creates a copy of the UpdateFailMalformedHTLC
12182 struct LDKUpdateFailMalformedHTLC UpdateFailMalformedHTLC_clone(const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR orig);
12185 * Frees any resources used by the CommitmentSigned, if is_owned is set and inner is non-NULL.
12187 void CommitmentSigned_free(struct LDKCommitmentSigned this_obj);
12192 const uint8_t (*CommitmentSigned_get_channel_id(const struct LDKCommitmentSigned *NONNULL_PTR this_ptr))[32];
12197 void CommitmentSigned_set_channel_id(struct LDKCommitmentSigned *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
12200 * A signature on the commitment transaction
12202 struct LDKSignature CommitmentSigned_get_signature(const struct LDKCommitmentSigned *NONNULL_PTR this_ptr);
12205 * A signature on the commitment transaction
12207 void CommitmentSigned_set_signature(struct LDKCommitmentSigned *NONNULL_PTR this_ptr, struct LDKSignature val);
12210 * Signatures on the HTLC transactions
12212 void CommitmentSigned_set_htlc_signatures(struct LDKCommitmentSigned *NONNULL_PTR this_ptr, struct LDKCVec_SignatureZ val);
12215 * Constructs a new CommitmentSigned given each field
12217 MUST_USE_RES struct LDKCommitmentSigned CommitmentSigned_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKSignature signature_arg, struct LDKCVec_SignatureZ htlc_signatures_arg);
12220 * Creates a copy of the CommitmentSigned
12222 struct LDKCommitmentSigned CommitmentSigned_clone(const struct LDKCommitmentSigned *NONNULL_PTR orig);
12225 * Frees any resources used by the RevokeAndACK, if is_owned is set and inner is non-NULL.
12227 void RevokeAndACK_free(struct LDKRevokeAndACK this_obj);
12232 const uint8_t (*RevokeAndACK_get_channel_id(const struct LDKRevokeAndACK *NONNULL_PTR this_ptr))[32];
12237 void RevokeAndACK_set_channel_id(struct LDKRevokeAndACK *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
12240 * The secret corresponding to the per-commitment point
12242 const uint8_t (*RevokeAndACK_get_per_commitment_secret(const struct LDKRevokeAndACK *NONNULL_PTR this_ptr))[32];
12245 * The secret corresponding to the per-commitment point
12247 void RevokeAndACK_set_per_commitment_secret(struct LDKRevokeAndACK *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
12250 * The next sender-broadcast commitment transaction's per-commitment point
12252 struct LDKPublicKey RevokeAndACK_get_next_per_commitment_point(const struct LDKRevokeAndACK *NONNULL_PTR this_ptr);
12255 * The next sender-broadcast commitment transaction's per-commitment point
12257 void RevokeAndACK_set_next_per_commitment_point(struct LDKRevokeAndACK *NONNULL_PTR this_ptr, struct LDKPublicKey val);
12260 * Constructs a new RevokeAndACK given each field
12262 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);
12265 * Creates a copy of the RevokeAndACK
12267 struct LDKRevokeAndACK RevokeAndACK_clone(const struct LDKRevokeAndACK *NONNULL_PTR orig);
12270 * Frees any resources used by the UpdateFee, if is_owned is set and inner is non-NULL.
12272 void UpdateFee_free(struct LDKUpdateFee this_obj);
12277 const uint8_t (*UpdateFee_get_channel_id(const struct LDKUpdateFee *NONNULL_PTR this_ptr))[32];
12282 void UpdateFee_set_channel_id(struct LDKUpdateFee *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
12285 * Fee rate per 1000-weight of the transaction
12287 uint32_t UpdateFee_get_feerate_per_kw(const struct LDKUpdateFee *NONNULL_PTR this_ptr);
12290 * Fee rate per 1000-weight of the transaction
12292 void UpdateFee_set_feerate_per_kw(struct LDKUpdateFee *NONNULL_PTR this_ptr, uint32_t val);
12295 * Constructs a new UpdateFee given each field
12297 MUST_USE_RES struct LDKUpdateFee UpdateFee_new(struct LDKThirtyTwoBytes channel_id_arg, uint32_t feerate_per_kw_arg);
12300 * Creates a copy of the UpdateFee
12302 struct LDKUpdateFee UpdateFee_clone(const struct LDKUpdateFee *NONNULL_PTR orig);
12305 * Frees any resources used by the DataLossProtect, if is_owned is set and inner is non-NULL.
12307 void DataLossProtect_free(struct LDKDataLossProtect this_obj);
12310 * Proof that the sender knows the per-commitment secret of a specific commitment transaction
12311 * belonging to the recipient
12313 const uint8_t (*DataLossProtect_get_your_last_per_commitment_secret(const struct LDKDataLossProtect *NONNULL_PTR this_ptr))[32];
12316 * Proof that the sender knows the per-commitment secret of a specific commitment transaction
12317 * belonging to the recipient
12319 void DataLossProtect_set_your_last_per_commitment_secret(struct LDKDataLossProtect *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
12322 * The sender's per-commitment point for their current commitment transaction
12324 struct LDKPublicKey DataLossProtect_get_my_current_per_commitment_point(const struct LDKDataLossProtect *NONNULL_PTR this_ptr);
12327 * The sender's per-commitment point for their current commitment transaction
12329 void DataLossProtect_set_my_current_per_commitment_point(struct LDKDataLossProtect *NONNULL_PTR this_ptr, struct LDKPublicKey val);
12332 * Constructs a new DataLossProtect given each field
12334 MUST_USE_RES struct LDKDataLossProtect DataLossProtect_new(struct LDKThirtyTwoBytes your_last_per_commitment_secret_arg, struct LDKPublicKey my_current_per_commitment_point_arg);
12337 * Creates a copy of the DataLossProtect
12339 struct LDKDataLossProtect DataLossProtect_clone(const struct LDKDataLossProtect *NONNULL_PTR orig);
12342 * Frees any resources used by the ChannelReestablish, if is_owned is set and inner is non-NULL.
12344 void ChannelReestablish_free(struct LDKChannelReestablish this_obj);
12349 const uint8_t (*ChannelReestablish_get_channel_id(const struct LDKChannelReestablish *NONNULL_PTR this_ptr))[32];
12354 void ChannelReestablish_set_channel_id(struct LDKChannelReestablish *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
12357 * The next commitment number for the sender
12359 uint64_t ChannelReestablish_get_next_local_commitment_number(const struct LDKChannelReestablish *NONNULL_PTR this_ptr);
12362 * The next commitment number for the sender
12364 void ChannelReestablish_set_next_local_commitment_number(struct LDKChannelReestablish *NONNULL_PTR this_ptr, uint64_t val);
12367 * The next commitment number for the recipient
12369 uint64_t ChannelReestablish_get_next_remote_commitment_number(const struct LDKChannelReestablish *NONNULL_PTR this_ptr);
12372 * The next commitment number for the recipient
12374 void ChannelReestablish_set_next_remote_commitment_number(struct LDKChannelReestablish *NONNULL_PTR this_ptr, uint64_t val);
12377 * Creates a copy of the ChannelReestablish
12379 struct LDKChannelReestablish ChannelReestablish_clone(const struct LDKChannelReestablish *NONNULL_PTR orig);
12382 * Frees any resources used by the AnnouncementSignatures, if is_owned is set and inner is non-NULL.
12384 void AnnouncementSignatures_free(struct LDKAnnouncementSignatures this_obj);
12389 const uint8_t (*AnnouncementSignatures_get_channel_id(const struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr))[32];
12394 void AnnouncementSignatures_set_channel_id(struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
12397 * The short channel ID
12399 uint64_t AnnouncementSignatures_get_short_channel_id(const struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr);
12402 * The short channel ID
12404 void AnnouncementSignatures_set_short_channel_id(struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr, uint64_t val);
12407 * A signature by the node key
12409 struct LDKSignature AnnouncementSignatures_get_node_signature(const struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr);
12412 * A signature by the node key
12414 void AnnouncementSignatures_set_node_signature(struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr, struct LDKSignature val);
12417 * A signature by the funding key
12419 struct LDKSignature AnnouncementSignatures_get_bitcoin_signature(const struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr);
12422 * A signature by the funding key
12424 void AnnouncementSignatures_set_bitcoin_signature(struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr, struct LDKSignature val);
12427 * Constructs a new AnnouncementSignatures given each field
12429 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);
12432 * Creates a copy of the AnnouncementSignatures
12434 struct LDKAnnouncementSignatures AnnouncementSignatures_clone(const struct LDKAnnouncementSignatures *NONNULL_PTR orig);
12437 * Frees any resources used by the NetAddress
12439 void NetAddress_free(struct LDKNetAddress this_ptr);
12442 * Creates a copy of the NetAddress
12444 struct LDKNetAddress NetAddress_clone(const struct LDKNetAddress *NONNULL_PTR orig);
12447 * Serialize the NetAddress object into a byte array which can be read by NetAddress_read
12449 struct LDKCVec_u8Z NetAddress_write(const struct LDKNetAddress *NONNULL_PTR obj);
12452 * Read a Result from a byte array, created by Result_write
12454 struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ Result_read(struct LDKu8slice ser);
12457 * Frees any resources used by the UnsignedNodeAnnouncement, if is_owned is set and inner is non-NULL.
12459 void UnsignedNodeAnnouncement_free(struct LDKUnsignedNodeAnnouncement this_obj);
12462 * The advertised features
12464 struct LDKNodeFeatures UnsignedNodeAnnouncement_get_features(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr);
12467 * The advertised features
12469 void UnsignedNodeAnnouncement_set_features(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKNodeFeatures val);
12472 * A strictly monotonic announcement counter, with gaps allowed
12474 uint32_t UnsignedNodeAnnouncement_get_timestamp(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr);
12477 * A strictly monotonic announcement counter, with gaps allowed
12479 void UnsignedNodeAnnouncement_set_timestamp(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, uint32_t val);
12482 * The node_id this announcement originated from (don't rebroadcast the node_announcement back
12485 struct LDKPublicKey UnsignedNodeAnnouncement_get_node_id(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr);
12488 * The node_id this announcement originated from (don't rebroadcast the node_announcement back
12491 void UnsignedNodeAnnouncement_set_node_id(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKPublicKey val);
12494 * An RGB color for UI purposes
12496 const uint8_t (*UnsignedNodeAnnouncement_get_rgb(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr))[3];
12499 * An RGB color for UI purposes
12501 void UnsignedNodeAnnouncement_set_rgb(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKThreeBytes val);
12504 * An alias, for UI purposes. This should be sanitized before use. There is no guarantee
12507 const uint8_t (*UnsignedNodeAnnouncement_get_alias(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr))[32];
12510 * An alias, for UI purposes. This should be sanitized before use. There is no guarantee
12513 void UnsignedNodeAnnouncement_set_alias(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
12516 * List of addresses on which this node is reachable
12518 void UnsignedNodeAnnouncement_set_addresses(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKCVec_NetAddressZ val);
12521 * Creates a copy of the UnsignedNodeAnnouncement
12523 struct LDKUnsignedNodeAnnouncement UnsignedNodeAnnouncement_clone(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR orig);
12526 * Frees any resources used by the NodeAnnouncement, if is_owned is set and inner is non-NULL.
12528 void NodeAnnouncement_free(struct LDKNodeAnnouncement this_obj);
12531 * The signature by the node key
12533 struct LDKSignature NodeAnnouncement_get_signature(const struct LDKNodeAnnouncement *NONNULL_PTR this_ptr);
12536 * The signature by the node key
12538 void NodeAnnouncement_set_signature(struct LDKNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKSignature val);
12541 * The actual content of the announcement
12543 struct LDKUnsignedNodeAnnouncement NodeAnnouncement_get_contents(const struct LDKNodeAnnouncement *NONNULL_PTR this_ptr);
12546 * The actual content of the announcement
12548 void NodeAnnouncement_set_contents(struct LDKNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKUnsignedNodeAnnouncement val);
12551 * Constructs a new NodeAnnouncement given each field
12553 MUST_USE_RES struct LDKNodeAnnouncement NodeAnnouncement_new(struct LDKSignature signature_arg, struct LDKUnsignedNodeAnnouncement contents_arg);
12556 * Creates a copy of the NodeAnnouncement
12558 struct LDKNodeAnnouncement NodeAnnouncement_clone(const struct LDKNodeAnnouncement *NONNULL_PTR orig);
12561 * Frees any resources used by the UnsignedChannelAnnouncement, if is_owned is set and inner is non-NULL.
12563 void UnsignedChannelAnnouncement_free(struct LDKUnsignedChannelAnnouncement this_obj);
12566 * The advertised channel features
12568 struct LDKChannelFeatures UnsignedChannelAnnouncement_get_features(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
12571 * The advertised channel features
12573 void UnsignedChannelAnnouncement_set_features(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKChannelFeatures val);
12576 * The genesis hash of the blockchain where the channel is to be opened
12578 const uint8_t (*UnsignedChannelAnnouncement_get_chain_hash(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr))[32];
12581 * The genesis hash of the blockchain where the channel is to be opened
12583 void UnsignedChannelAnnouncement_set_chain_hash(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
12586 * The short channel ID
12588 uint64_t UnsignedChannelAnnouncement_get_short_channel_id(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
12591 * The short channel ID
12593 void UnsignedChannelAnnouncement_set_short_channel_id(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, uint64_t val);
12596 * One of the two node_ids which are endpoints of this channel
12598 struct LDKPublicKey UnsignedChannelAnnouncement_get_node_id_1(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
12601 * One of the two node_ids which are endpoints of this channel
12603 void UnsignedChannelAnnouncement_set_node_id_1(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKPublicKey val);
12606 * The other of the two node_ids which are endpoints of this channel
12608 struct LDKPublicKey UnsignedChannelAnnouncement_get_node_id_2(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
12611 * The other of the two node_ids which are endpoints of this channel
12613 void UnsignedChannelAnnouncement_set_node_id_2(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKPublicKey val);
12616 * The funding key for the first node
12618 struct LDKPublicKey UnsignedChannelAnnouncement_get_bitcoin_key_1(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
12621 * The funding key for the first node
12623 void UnsignedChannelAnnouncement_set_bitcoin_key_1(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKPublicKey val);
12626 * The funding key for the second node
12628 struct LDKPublicKey UnsignedChannelAnnouncement_get_bitcoin_key_2(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
12631 * The funding key for the second node
12633 void UnsignedChannelAnnouncement_set_bitcoin_key_2(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKPublicKey val);
12636 * Creates a copy of the UnsignedChannelAnnouncement
12638 struct LDKUnsignedChannelAnnouncement UnsignedChannelAnnouncement_clone(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR orig);
12641 * Frees any resources used by the ChannelAnnouncement, if is_owned is set and inner is non-NULL.
12643 void ChannelAnnouncement_free(struct LDKChannelAnnouncement this_obj);
12646 * Authentication of the announcement by the first public node
12648 struct LDKSignature ChannelAnnouncement_get_node_signature_1(const struct LDKChannelAnnouncement *NONNULL_PTR this_ptr);
12651 * Authentication of the announcement by the first public node
12653 void ChannelAnnouncement_set_node_signature_1(struct LDKChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKSignature val);
12656 * Authentication of the announcement by the second public node
12658 struct LDKSignature ChannelAnnouncement_get_node_signature_2(const struct LDKChannelAnnouncement *NONNULL_PTR this_ptr);
12661 * Authentication of the announcement by the second public node
12663 void ChannelAnnouncement_set_node_signature_2(struct LDKChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKSignature val);
12666 * Proof of funding UTXO ownership by the first public node
12668 struct LDKSignature ChannelAnnouncement_get_bitcoin_signature_1(const struct LDKChannelAnnouncement *NONNULL_PTR this_ptr);
12671 * Proof of funding UTXO ownership by the first public node
12673 void ChannelAnnouncement_set_bitcoin_signature_1(struct LDKChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKSignature val);
12676 * Proof of funding UTXO ownership by the second public node
12678 struct LDKSignature ChannelAnnouncement_get_bitcoin_signature_2(const struct LDKChannelAnnouncement *NONNULL_PTR this_ptr);
12681 * Proof of funding UTXO ownership by the second public node
12683 void ChannelAnnouncement_set_bitcoin_signature_2(struct LDKChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKSignature val);
12686 * The actual announcement
12688 struct LDKUnsignedChannelAnnouncement ChannelAnnouncement_get_contents(const struct LDKChannelAnnouncement *NONNULL_PTR this_ptr);
12691 * The actual announcement
12693 void ChannelAnnouncement_set_contents(struct LDKChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKUnsignedChannelAnnouncement val);
12696 * Constructs a new ChannelAnnouncement given each field
12698 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);
12701 * Creates a copy of the ChannelAnnouncement
12703 struct LDKChannelAnnouncement ChannelAnnouncement_clone(const struct LDKChannelAnnouncement *NONNULL_PTR orig);
12706 * Frees any resources used by the UnsignedChannelUpdate, if is_owned is set and inner is non-NULL.
12708 void UnsignedChannelUpdate_free(struct LDKUnsignedChannelUpdate this_obj);
12711 * The genesis hash of the blockchain where the channel is to be opened
12713 const uint8_t (*UnsignedChannelUpdate_get_chain_hash(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr))[32];
12716 * The genesis hash of the blockchain where the channel is to be opened
12718 void UnsignedChannelUpdate_set_chain_hash(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
12721 * The short channel ID
12723 uint64_t UnsignedChannelUpdate_get_short_channel_id(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
12726 * The short channel ID
12728 void UnsignedChannelUpdate_set_short_channel_id(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint64_t val);
12731 * A strictly monotonic announcement counter, with gaps allowed, specific to this channel
12733 uint32_t UnsignedChannelUpdate_get_timestamp(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
12736 * A strictly monotonic announcement counter, with gaps allowed, specific to this channel
12738 void UnsignedChannelUpdate_set_timestamp(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint32_t val);
12743 uint8_t UnsignedChannelUpdate_get_flags(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
12748 void UnsignedChannelUpdate_set_flags(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint8_t val);
12751 * The number of blocks such that if:
12752 * `incoming_htlc.cltv_expiry < outgoing_htlc.cltv_expiry + cltv_expiry_delta`
12753 * then we need to fail the HTLC backwards. When forwarding an HTLC, cltv_expiry_delta determines
12754 * the outgoing HTLC's minimum cltv_expiry value -- so, if an incoming HTLC comes in with a
12755 * cltv_expiry of 100000, and the node we're forwarding to has a cltv_expiry_delta value of 10,
12756 * then we'll check that the outgoing HTLC's cltv_expiry value is at least 100010 before
12757 * forwarding. Note that the HTLC sender is the one who originally sets this value when
12758 * constructing the route.
12760 uint16_t UnsignedChannelUpdate_get_cltv_expiry_delta(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
12763 * The number of blocks such that if:
12764 * `incoming_htlc.cltv_expiry < outgoing_htlc.cltv_expiry + cltv_expiry_delta`
12765 * then we need to fail the HTLC backwards. When forwarding an HTLC, cltv_expiry_delta determines
12766 * the outgoing HTLC's minimum cltv_expiry value -- so, if an incoming HTLC comes in with a
12767 * cltv_expiry of 100000, and the node we're forwarding to has a cltv_expiry_delta value of 10,
12768 * then we'll check that the outgoing HTLC's cltv_expiry value is at least 100010 before
12769 * forwarding. Note that the HTLC sender is the one who originally sets this value when
12770 * constructing the route.
12772 void UnsignedChannelUpdate_set_cltv_expiry_delta(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint16_t val);
12775 * The minimum HTLC size incoming to sender, in milli-satoshi
12777 uint64_t UnsignedChannelUpdate_get_htlc_minimum_msat(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
12780 * The minimum HTLC size incoming to sender, in milli-satoshi
12782 void UnsignedChannelUpdate_set_htlc_minimum_msat(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint64_t val);
12785 * The base HTLC fee charged by sender, in milli-satoshi
12787 uint32_t UnsignedChannelUpdate_get_fee_base_msat(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
12790 * The base HTLC fee charged by sender, in milli-satoshi
12792 void UnsignedChannelUpdate_set_fee_base_msat(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint32_t val);
12795 * The amount to fee multiplier, in micro-satoshi
12797 uint32_t UnsignedChannelUpdate_get_fee_proportional_millionths(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
12800 * The amount to fee multiplier, in micro-satoshi
12802 void UnsignedChannelUpdate_set_fee_proportional_millionths(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint32_t val);
12805 * Creates a copy of the UnsignedChannelUpdate
12807 struct LDKUnsignedChannelUpdate UnsignedChannelUpdate_clone(const struct LDKUnsignedChannelUpdate *NONNULL_PTR orig);
12810 * Frees any resources used by the ChannelUpdate, if is_owned is set and inner is non-NULL.
12812 void ChannelUpdate_free(struct LDKChannelUpdate this_obj);
12815 * A signature of the channel update
12817 struct LDKSignature ChannelUpdate_get_signature(const struct LDKChannelUpdate *NONNULL_PTR this_ptr);
12820 * A signature of the channel update
12822 void ChannelUpdate_set_signature(struct LDKChannelUpdate *NONNULL_PTR this_ptr, struct LDKSignature val);
12825 * The actual channel update
12827 struct LDKUnsignedChannelUpdate ChannelUpdate_get_contents(const struct LDKChannelUpdate *NONNULL_PTR this_ptr);
12830 * The actual channel update
12832 void ChannelUpdate_set_contents(struct LDKChannelUpdate *NONNULL_PTR this_ptr, struct LDKUnsignedChannelUpdate val);
12835 * Constructs a new ChannelUpdate given each field
12837 MUST_USE_RES struct LDKChannelUpdate ChannelUpdate_new(struct LDKSignature signature_arg, struct LDKUnsignedChannelUpdate contents_arg);
12840 * Creates a copy of the ChannelUpdate
12842 struct LDKChannelUpdate ChannelUpdate_clone(const struct LDKChannelUpdate *NONNULL_PTR orig);
12845 * Frees any resources used by the QueryChannelRange, if is_owned is set and inner is non-NULL.
12847 void QueryChannelRange_free(struct LDKQueryChannelRange this_obj);
12850 * The genesis hash of the blockchain being queried
12852 const uint8_t (*QueryChannelRange_get_chain_hash(const struct LDKQueryChannelRange *NONNULL_PTR this_ptr))[32];
12855 * The genesis hash of the blockchain being queried
12857 void QueryChannelRange_set_chain_hash(struct LDKQueryChannelRange *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
12860 * The height of the first block for the channel UTXOs being queried
12862 uint32_t QueryChannelRange_get_first_blocknum(const struct LDKQueryChannelRange *NONNULL_PTR this_ptr);
12865 * The height of the first block for the channel UTXOs being queried
12867 void QueryChannelRange_set_first_blocknum(struct LDKQueryChannelRange *NONNULL_PTR this_ptr, uint32_t val);
12870 * The number of blocks to include in the query results
12872 uint32_t QueryChannelRange_get_number_of_blocks(const struct LDKQueryChannelRange *NONNULL_PTR this_ptr);
12875 * The number of blocks to include in the query results
12877 void QueryChannelRange_set_number_of_blocks(struct LDKQueryChannelRange *NONNULL_PTR this_ptr, uint32_t val);
12880 * Constructs a new QueryChannelRange given each field
12882 MUST_USE_RES struct LDKQueryChannelRange QueryChannelRange_new(struct LDKThirtyTwoBytes chain_hash_arg, uint32_t first_blocknum_arg, uint32_t number_of_blocks_arg);
12885 * Creates a copy of the QueryChannelRange
12887 struct LDKQueryChannelRange QueryChannelRange_clone(const struct LDKQueryChannelRange *NONNULL_PTR orig);
12890 * Frees any resources used by the ReplyChannelRange, if is_owned is set and inner is non-NULL.
12892 void ReplyChannelRange_free(struct LDKReplyChannelRange this_obj);
12895 * The genesis hash of the blockchain being queried
12897 const uint8_t (*ReplyChannelRange_get_chain_hash(const struct LDKReplyChannelRange *NONNULL_PTR this_ptr))[32];
12900 * The genesis hash of the blockchain being queried
12902 void ReplyChannelRange_set_chain_hash(struct LDKReplyChannelRange *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
12905 * The height of the first block in the range of the reply
12907 uint32_t ReplyChannelRange_get_first_blocknum(const struct LDKReplyChannelRange *NONNULL_PTR this_ptr);
12910 * The height of the first block in the range of the reply
12912 void ReplyChannelRange_set_first_blocknum(struct LDKReplyChannelRange *NONNULL_PTR this_ptr, uint32_t val);
12915 * The number of blocks included in the range of the reply
12917 uint32_t ReplyChannelRange_get_number_of_blocks(const struct LDKReplyChannelRange *NONNULL_PTR this_ptr);
12920 * The number of blocks included in the range of the reply
12922 void ReplyChannelRange_set_number_of_blocks(struct LDKReplyChannelRange *NONNULL_PTR this_ptr, uint32_t val);
12925 * True when this is the final reply for a query
12927 bool ReplyChannelRange_get_sync_complete(const struct LDKReplyChannelRange *NONNULL_PTR this_ptr);
12930 * True when this is the final reply for a query
12932 void ReplyChannelRange_set_sync_complete(struct LDKReplyChannelRange *NONNULL_PTR this_ptr, bool val);
12935 * The short_channel_ids in the channel range
12937 void ReplyChannelRange_set_short_channel_ids(struct LDKReplyChannelRange *NONNULL_PTR this_ptr, struct LDKCVec_u64Z val);
12940 * Constructs a new ReplyChannelRange given each field
12942 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);
12945 * Creates a copy of the ReplyChannelRange
12947 struct LDKReplyChannelRange ReplyChannelRange_clone(const struct LDKReplyChannelRange *NONNULL_PTR orig);
12950 * Frees any resources used by the QueryShortChannelIds, if is_owned is set and inner is non-NULL.
12952 void QueryShortChannelIds_free(struct LDKQueryShortChannelIds this_obj);
12955 * The genesis hash of the blockchain being queried
12957 const uint8_t (*QueryShortChannelIds_get_chain_hash(const struct LDKQueryShortChannelIds *NONNULL_PTR this_ptr))[32];
12960 * The genesis hash of the blockchain being queried
12962 void QueryShortChannelIds_set_chain_hash(struct LDKQueryShortChannelIds *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
12965 * The short_channel_ids that are being queried
12967 void QueryShortChannelIds_set_short_channel_ids(struct LDKQueryShortChannelIds *NONNULL_PTR this_ptr, struct LDKCVec_u64Z val);
12970 * Constructs a new QueryShortChannelIds given each field
12972 MUST_USE_RES struct LDKQueryShortChannelIds QueryShortChannelIds_new(struct LDKThirtyTwoBytes chain_hash_arg, struct LDKCVec_u64Z short_channel_ids_arg);
12975 * Creates a copy of the QueryShortChannelIds
12977 struct LDKQueryShortChannelIds QueryShortChannelIds_clone(const struct LDKQueryShortChannelIds *NONNULL_PTR orig);
12980 * Frees any resources used by the ReplyShortChannelIdsEnd, if is_owned is set and inner is non-NULL.
12982 void ReplyShortChannelIdsEnd_free(struct LDKReplyShortChannelIdsEnd this_obj);
12985 * The genesis hash of the blockchain that was queried
12987 const uint8_t (*ReplyShortChannelIdsEnd_get_chain_hash(const struct LDKReplyShortChannelIdsEnd *NONNULL_PTR this_ptr))[32];
12990 * The genesis hash of the blockchain that was queried
12992 void ReplyShortChannelIdsEnd_set_chain_hash(struct LDKReplyShortChannelIdsEnd *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
12995 * Indicates if the query recipient maintains up-to-date channel
12996 * information for the chain_hash
12998 bool ReplyShortChannelIdsEnd_get_full_information(const struct LDKReplyShortChannelIdsEnd *NONNULL_PTR this_ptr);
13001 * Indicates if the query recipient maintains up-to-date channel
13002 * information for the chain_hash
13004 void ReplyShortChannelIdsEnd_set_full_information(struct LDKReplyShortChannelIdsEnd *NONNULL_PTR this_ptr, bool val);
13007 * Constructs a new ReplyShortChannelIdsEnd given each field
13009 MUST_USE_RES struct LDKReplyShortChannelIdsEnd ReplyShortChannelIdsEnd_new(struct LDKThirtyTwoBytes chain_hash_arg, bool full_information_arg);
13012 * Creates a copy of the ReplyShortChannelIdsEnd
13014 struct LDKReplyShortChannelIdsEnd ReplyShortChannelIdsEnd_clone(const struct LDKReplyShortChannelIdsEnd *NONNULL_PTR orig);
13017 * Frees any resources used by the GossipTimestampFilter, if is_owned is set and inner is non-NULL.
13019 void GossipTimestampFilter_free(struct LDKGossipTimestampFilter this_obj);
13022 * The genesis hash of the blockchain for channel and node information
13024 const uint8_t (*GossipTimestampFilter_get_chain_hash(const struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr))[32];
13027 * The genesis hash of the blockchain for channel and node information
13029 void GossipTimestampFilter_set_chain_hash(struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
13032 * The starting unix timestamp
13034 uint32_t GossipTimestampFilter_get_first_timestamp(const struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr);
13037 * The starting unix timestamp
13039 void GossipTimestampFilter_set_first_timestamp(struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr, uint32_t val);
13042 * The range of information in seconds
13044 uint32_t GossipTimestampFilter_get_timestamp_range(const struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr);
13047 * The range of information in seconds
13049 void GossipTimestampFilter_set_timestamp_range(struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr, uint32_t val);
13052 * Constructs a new GossipTimestampFilter given each field
13054 MUST_USE_RES struct LDKGossipTimestampFilter GossipTimestampFilter_new(struct LDKThirtyTwoBytes chain_hash_arg, uint32_t first_timestamp_arg, uint32_t timestamp_range_arg);
13057 * Creates a copy of the GossipTimestampFilter
13059 struct LDKGossipTimestampFilter GossipTimestampFilter_clone(const struct LDKGossipTimestampFilter *NONNULL_PTR orig);
13062 * Frees any resources used by the ErrorAction
13064 void ErrorAction_free(struct LDKErrorAction this_ptr);
13067 * Creates a copy of the ErrorAction
13069 struct LDKErrorAction ErrorAction_clone(const struct LDKErrorAction *NONNULL_PTR orig);
13072 * Frees any resources used by the LightningError, if is_owned is set and inner is non-NULL.
13074 void LightningError_free(struct LDKLightningError this_obj);
13077 * A human-readable message describing the error
13079 struct LDKStr LightningError_get_err(const struct LDKLightningError *NONNULL_PTR this_ptr);
13082 * A human-readable message describing the error
13084 void LightningError_set_err(struct LDKLightningError *NONNULL_PTR this_ptr, struct LDKCVec_u8Z val);
13087 * The action which should be taken against the offending peer.
13089 struct LDKErrorAction LightningError_get_action(const struct LDKLightningError *NONNULL_PTR this_ptr);
13092 * The action which should be taken against the offending peer.
13094 void LightningError_set_action(struct LDKLightningError *NONNULL_PTR this_ptr, struct LDKErrorAction val);
13097 * Constructs a new LightningError given each field
13099 MUST_USE_RES struct LDKLightningError LightningError_new(struct LDKCVec_u8Z err_arg, struct LDKErrorAction action_arg);
13102 * Creates a copy of the LightningError
13104 struct LDKLightningError LightningError_clone(const struct LDKLightningError *NONNULL_PTR orig);
13107 * Frees any resources used by the CommitmentUpdate, if is_owned is set and inner is non-NULL.
13109 void CommitmentUpdate_free(struct LDKCommitmentUpdate this_obj);
13112 * update_add_htlc messages which should be sent
13114 void CommitmentUpdate_set_update_add_htlcs(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKCVec_UpdateAddHTLCZ val);
13117 * update_fulfill_htlc messages which should be sent
13119 void CommitmentUpdate_set_update_fulfill_htlcs(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKCVec_UpdateFulfillHTLCZ val);
13122 * update_fail_htlc messages which should be sent
13124 void CommitmentUpdate_set_update_fail_htlcs(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKCVec_UpdateFailHTLCZ val);
13127 * update_fail_malformed_htlc messages which should be sent
13129 void CommitmentUpdate_set_update_fail_malformed_htlcs(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKCVec_UpdateFailMalformedHTLCZ val);
13132 * An update_fee message which should be sent
13134 struct LDKUpdateFee CommitmentUpdate_get_update_fee(const struct LDKCommitmentUpdate *NONNULL_PTR this_ptr);
13137 * An update_fee message which should be sent
13139 void CommitmentUpdate_set_update_fee(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKUpdateFee val);
13142 * Finally, the commitment_signed message which should be sent
13144 struct LDKCommitmentSigned CommitmentUpdate_get_commitment_signed(const struct LDKCommitmentUpdate *NONNULL_PTR this_ptr);
13147 * Finally, the commitment_signed message which should be sent
13149 void CommitmentUpdate_set_commitment_signed(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKCommitmentSigned val);
13152 * Constructs a new CommitmentUpdate given each field
13154 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);
13157 * Creates a copy of the CommitmentUpdate
13159 struct LDKCommitmentUpdate CommitmentUpdate_clone(const struct LDKCommitmentUpdate *NONNULL_PTR orig);
13162 * Frees any resources used by the HTLCFailChannelUpdate
13164 void HTLCFailChannelUpdate_free(struct LDKHTLCFailChannelUpdate this_ptr);
13167 * Creates a copy of the HTLCFailChannelUpdate
13169 struct LDKHTLCFailChannelUpdate HTLCFailChannelUpdate_clone(const struct LDKHTLCFailChannelUpdate *NONNULL_PTR orig);
13172 * Calls the free function if one is set
13174 void ChannelMessageHandler_free(struct LDKChannelMessageHandler this_ptr);
13177 * Calls the free function if one is set
13179 void RoutingMessageHandler_free(struct LDKRoutingMessageHandler this_ptr);
13182 * Serialize the AcceptChannel object into a byte array which can be read by AcceptChannel_read
13184 struct LDKCVec_u8Z AcceptChannel_write(const struct LDKAcceptChannel *NONNULL_PTR obj);
13187 * Read a AcceptChannel from a byte array, created by AcceptChannel_write
13189 struct LDKCResult_AcceptChannelDecodeErrorZ AcceptChannel_read(struct LDKu8slice ser);
13192 * Serialize the AnnouncementSignatures object into a byte array which can be read by AnnouncementSignatures_read
13194 struct LDKCVec_u8Z AnnouncementSignatures_write(const struct LDKAnnouncementSignatures *NONNULL_PTR obj);
13197 * Read a AnnouncementSignatures from a byte array, created by AnnouncementSignatures_write
13199 struct LDKCResult_AnnouncementSignaturesDecodeErrorZ AnnouncementSignatures_read(struct LDKu8slice ser);
13202 * Serialize the ChannelReestablish object into a byte array which can be read by ChannelReestablish_read
13204 struct LDKCVec_u8Z ChannelReestablish_write(const struct LDKChannelReestablish *NONNULL_PTR obj);
13207 * Read a ChannelReestablish from a byte array, created by ChannelReestablish_write
13209 struct LDKCResult_ChannelReestablishDecodeErrorZ ChannelReestablish_read(struct LDKu8slice ser);
13212 * Serialize the ClosingSigned object into a byte array which can be read by ClosingSigned_read
13214 struct LDKCVec_u8Z ClosingSigned_write(const struct LDKClosingSigned *NONNULL_PTR obj);
13217 * Read a ClosingSigned from a byte array, created by ClosingSigned_write
13219 struct LDKCResult_ClosingSignedDecodeErrorZ ClosingSigned_read(struct LDKu8slice ser);
13222 * Serialize the CommitmentSigned object into a byte array which can be read by CommitmentSigned_read
13224 struct LDKCVec_u8Z CommitmentSigned_write(const struct LDKCommitmentSigned *NONNULL_PTR obj);
13227 * Read a CommitmentSigned from a byte array, created by CommitmentSigned_write
13229 struct LDKCResult_CommitmentSignedDecodeErrorZ CommitmentSigned_read(struct LDKu8slice ser);
13232 * Serialize the FundingCreated object into a byte array which can be read by FundingCreated_read
13234 struct LDKCVec_u8Z FundingCreated_write(const struct LDKFundingCreated *NONNULL_PTR obj);
13237 * Read a FundingCreated from a byte array, created by FundingCreated_write
13239 struct LDKCResult_FundingCreatedDecodeErrorZ FundingCreated_read(struct LDKu8slice ser);
13242 * Serialize the FundingSigned object into a byte array which can be read by FundingSigned_read
13244 struct LDKCVec_u8Z FundingSigned_write(const struct LDKFundingSigned *NONNULL_PTR obj);
13247 * Read a FundingSigned from a byte array, created by FundingSigned_write
13249 struct LDKCResult_FundingSignedDecodeErrorZ FundingSigned_read(struct LDKu8slice ser);
13252 * Serialize the FundingLocked object into a byte array which can be read by FundingLocked_read
13254 struct LDKCVec_u8Z FundingLocked_write(const struct LDKFundingLocked *NONNULL_PTR obj);
13257 * Read a FundingLocked from a byte array, created by FundingLocked_write
13259 struct LDKCResult_FundingLockedDecodeErrorZ FundingLocked_read(struct LDKu8slice ser);
13262 * Serialize the Init object into a byte array which can be read by Init_read
13264 struct LDKCVec_u8Z Init_write(const struct LDKInit *NONNULL_PTR obj);
13267 * Read a Init from a byte array, created by Init_write
13269 struct LDKCResult_InitDecodeErrorZ Init_read(struct LDKu8slice ser);
13272 * Serialize the OpenChannel object into a byte array which can be read by OpenChannel_read
13274 struct LDKCVec_u8Z OpenChannel_write(const struct LDKOpenChannel *NONNULL_PTR obj);
13277 * Read a OpenChannel from a byte array, created by OpenChannel_write
13279 struct LDKCResult_OpenChannelDecodeErrorZ OpenChannel_read(struct LDKu8slice ser);
13282 * Serialize the RevokeAndACK object into a byte array which can be read by RevokeAndACK_read
13284 struct LDKCVec_u8Z RevokeAndACK_write(const struct LDKRevokeAndACK *NONNULL_PTR obj);
13287 * Read a RevokeAndACK from a byte array, created by RevokeAndACK_write
13289 struct LDKCResult_RevokeAndACKDecodeErrorZ RevokeAndACK_read(struct LDKu8slice ser);
13292 * Serialize the Shutdown object into a byte array which can be read by Shutdown_read
13294 struct LDKCVec_u8Z Shutdown_write(const struct LDKShutdown *NONNULL_PTR obj);
13297 * Read a Shutdown from a byte array, created by Shutdown_write
13299 struct LDKCResult_ShutdownDecodeErrorZ Shutdown_read(struct LDKu8slice ser);
13302 * Serialize the UpdateFailHTLC object into a byte array which can be read by UpdateFailHTLC_read
13304 struct LDKCVec_u8Z UpdateFailHTLC_write(const struct LDKUpdateFailHTLC *NONNULL_PTR obj);
13307 * Read a UpdateFailHTLC from a byte array, created by UpdateFailHTLC_write
13309 struct LDKCResult_UpdateFailHTLCDecodeErrorZ UpdateFailHTLC_read(struct LDKu8slice ser);
13312 * Serialize the UpdateFailMalformedHTLC object into a byte array which can be read by UpdateFailMalformedHTLC_read
13314 struct LDKCVec_u8Z UpdateFailMalformedHTLC_write(const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR obj);
13317 * Read a UpdateFailMalformedHTLC from a byte array, created by UpdateFailMalformedHTLC_write
13319 struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ UpdateFailMalformedHTLC_read(struct LDKu8slice ser);
13322 * Serialize the UpdateFee object into a byte array which can be read by UpdateFee_read
13324 struct LDKCVec_u8Z UpdateFee_write(const struct LDKUpdateFee *NONNULL_PTR obj);
13327 * Read a UpdateFee from a byte array, created by UpdateFee_write
13329 struct LDKCResult_UpdateFeeDecodeErrorZ UpdateFee_read(struct LDKu8slice ser);
13332 * Serialize the UpdateFulfillHTLC object into a byte array which can be read by UpdateFulfillHTLC_read
13334 struct LDKCVec_u8Z UpdateFulfillHTLC_write(const struct LDKUpdateFulfillHTLC *NONNULL_PTR obj);
13337 * Read a UpdateFulfillHTLC from a byte array, created by UpdateFulfillHTLC_write
13339 struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ UpdateFulfillHTLC_read(struct LDKu8slice ser);
13342 * Serialize the UpdateAddHTLC object into a byte array which can be read by UpdateAddHTLC_read
13344 struct LDKCVec_u8Z UpdateAddHTLC_write(const struct LDKUpdateAddHTLC *NONNULL_PTR obj);
13347 * Read a UpdateAddHTLC from a byte array, created by UpdateAddHTLC_write
13349 struct LDKCResult_UpdateAddHTLCDecodeErrorZ UpdateAddHTLC_read(struct LDKu8slice ser);
13352 * Serialize the Ping object into a byte array which can be read by Ping_read
13354 struct LDKCVec_u8Z Ping_write(const struct LDKPing *NONNULL_PTR obj);
13357 * Read a Ping from a byte array, created by Ping_write
13359 struct LDKCResult_PingDecodeErrorZ Ping_read(struct LDKu8slice ser);
13362 * Serialize the Pong object into a byte array which can be read by Pong_read
13364 struct LDKCVec_u8Z Pong_write(const struct LDKPong *NONNULL_PTR obj);
13367 * Read a Pong from a byte array, created by Pong_write
13369 struct LDKCResult_PongDecodeErrorZ Pong_read(struct LDKu8slice ser);
13372 * Serialize the UnsignedChannelAnnouncement object into a byte array which can be read by UnsignedChannelAnnouncement_read
13374 struct LDKCVec_u8Z UnsignedChannelAnnouncement_write(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR obj);
13377 * Read a UnsignedChannelAnnouncement from a byte array, created by UnsignedChannelAnnouncement_write
13379 struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ UnsignedChannelAnnouncement_read(struct LDKu8slice ser);
13382 * Serialize the ChannelAnnouncement object into a byte array which can be read by ChannelAnnouncement_read
13384 struct LDKCVec_u8Z ChannelAnnouncement_write(const struct LDKChannelAnnouncement *NONNULL_PTR obj);
13387 * Read a ChannelAnnouncement from a byte array, created by ChannelAnnouncement_write
13389 struct LDKCResult_ChannelAnnouncementDecodeErrorZ ChannelAnnouncement_read(struct LDKu8slice ser);
13392 * Serialize the UnsignedChannelUpdate object into a byte array which can be read by UnsignedChannelUpdate_read
13394 struct LDKCVec_u8Z UnsignedChannelUpdate_write(const struct LDKUnsignedChannelUpdate *NONNULL_PTR obj);
13397 * Read a UnsignedChannelUpdate from a byte array, created by UnsignedChannelUpdate_write
13399 struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ UnsignedChannelUpdate_read(struct LDKu8slice ser);
13402 * Serialize the ChannelUpdate object into a byte array which can be read by ChannelUpdate_read
13404 struct LDKCVec_u8Z ChannelUpdate_write(const struct LDKChannelUpdate *NONNULL_PTR obj);
13407 * Read a ChannelUpdate from a byte array, created by ChannelUpdate_write
13409 struct LDKCResult_ChannelUpdateDecodeErrorZ ChannelUpdate_read(struct LDKu8slice ser);
13412 * Serialize the ErrorMessage object into a byte array which can be read by ErrorMessage_read
13414 struct LDKCVec_u8Z ErrorMessage_write(const struct LDKErrorMessage *NONNULL_PTR obj);
13417 * Read a ErrorMessage from a byte array, created by ErrorMessage_write
13419 struct LDKCResult_ErrorMessageDecodeErrorZ ErrorMessage_read(struct LDKu8slice ser);
13422 * Serialize the UnsignedNodeAnnouncement object into a byte array which can be read by UnsignedNodeAnnouncement_read
13424 struct LDKCVec_u8Z UnsignedNodeAnnouncement_write(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR obj);
13427 * Read a UnsignedNodeAnnouncement from a byte array, created by UnsignedNodeAnnouncement_write
13429 struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ UnsignedNodeAnnouncement_read(struct LDKu8slice ser);
13432 * Serialize the NodeAnnouncement object into a byte array which can be read by NodeAnnouncement_read
13434 struct LDKCVec_u8Z NodeAnnouncement_write(const struct LDKNodeAnnouncement *NONNULL_PTR obj);
13437 * Read a NodeAnnouncement from a byte array, created by NodeAnnouncement_write
13439 struct LDKCResult_NodeAnnouncementDecodeErrorZ NodeAnnouncement_read(struct LDKu8slice ser);
13442 * Read a QueryShortChannelIds from a byte array, created by QueryShortChannelIds_write
13444 struct LDKCResult_QueryShortChannelIdsDecodeErrorZ QueryShortChannelIds_read(struct LDKu8slice ser);
13447 * Serialize the QueryShortChannelIds object into a byte array which can be read by QueryShortChannelIds_read
13449 struct LDKCVec_u8Z QueryShortChannelIds_write(const struct LDKQueryShortChannelIds *NONNULL_PTR obj);
13452 * Read a ReplyShortChannelIdsEnd from a byte array, created by ReplyShortChannelIdsEnd_write
13454 struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ ReplyShortChannelIdsEnd_read(struct LDKu8slice ser);
13457 * Serialize the ReplyShortChannelIdsEnd object into a byte array which can be read by ReplyShortChannelIdsEnd_read
13459 struct LDKCVec_u8Z ReplyShortChannelIdsEnd_write(const struct LDKReplyShortChannelIdsEnd *NONNULL_PTR obj);
13462 *\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
13464 MUST_USE_RES uint32_t QueryChannelRange_end_blocknum(const struct LDKQueryChannelRange *NONNULL_PTR this_arg);
13467 * Read a QueryChannelRange from a byte array, created by QueryChannelRange_write
13469 struct LDKCResult_QueryChannelRangeDecodeErrorZ QueryChannelRange_read(struct LDKu8slice ser);
13472 * Serialize the QueryChannelRange object into a byte array which can be read by QueryChannelRange_read
13474 struct LDKCVec_u8Z QueryChannelRange_write(const struct LDKQueryChannelRange *NONNULL_PTR obj);
13477 * Read a ReplyChannelRange from a byte array, created by ReplyChannelRange_write
13479 struct LDKCResult_ReplyChannelRangeDecodeErrorZ ReplyChannelRange_read(struct LDKu8slice ser);
13482 * Serialize the ReplyChannelRange object into a byte array which can be read by ReplyChannelRange_read
13484 struct LDKCVec_u8Z ReplyChannelRange_write(const struct LDKReplyChannelRange *NONNULL_PTR obj);
13487 * Read a GossipTimestampFilter from a byte array, created by GossipTimestampFilter_write
13489 struct LDKCResult_GossipTimestampFilterDecodeErrorZ GossipTimestampFilter_read(struct LDKu8slice ser);
13492 * Serialize the GossipTimestampFilter object into a byte array which can be read by GossipTimestampFilter_read
13494 struct LDKCVec_u8Z GossipTimestampFilter_write(const struct LDKGossipTimestampFilter *NONNULL_PTR obj);
13497 * Frees any resources used by the IgnoringMessageHandler, if is_owned is set and inner is non-NULL.
13499 void IgnoringMessageHandler_free(struct LDKIgnoringMessageHandler this_obj);
13502 * Constructs a new IgnoringMessageHandler given each field
13504 MUST_USE_RES struct LDKIgnoringMessageHandler IgnoringMessageHandler_new(void);
13507 * Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
13508 * This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
13510 struct LDKMessageSendEventsProvider IgnoringMessageHandler_as_MessageSendEventsProvider(const struct LDKIgnoringMessageHandler *NONNULL_PTR this_arg);
13513 * Constructs a new RoutingMessageHandler which calls the relevant methods on this_arg.
13514 * This copies the `inner` pointer in this_arg and thus the returned RoutingMessageHandler must be freed before this_arg is
13516 struct LDKRoutingMessageHandler IgnoringMessageHandler_as_RoutingMessageHandler(const struct LDKIgnoringMessageHandler *NONNULL_PTR this_arg);
13519 * Frees any resources used by the ErroringMessageHandler, if is_owned is set and inner is non-NULL.
13521 void ErroringMessageHandler_free(struct LDKErroringMessageHandler this_obj);
13524 * Constructs a new ErroringMessageHandler
13526 MUST_USE_RES struct LDKErroringMessageHandler ErroringMessageHandler_new(void);
13529 * Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
13530 * This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
13532 struct LDKMessageSendEventsProvider ErroringMessageHandler_as_MessageSendEventsProvider(const struct LDKErroringMessageHandler *NONNULL_PTR this_arg);
13535 * Constructs a new ChannelMessageHandler which calls the relevant methods on this_arg.
13536 * This copies the `inner` pointer in this_arg and thus the returned ChannelMessageHandler must be freed before this_arg is
13538 struct LDKChannelMessageHandler ErroringMessageHandler_as_ChannelMessageHandler(const struct LDKErroringMessageHandler *NONNULL_PTR this_arg);
13541 * Frees any resources used by the MessageHandler, if is_owned is set and inner is non-NULL.
13543 void MessageHandler_free(struct LDKMessageHandler this_obj);
13546 * A message handler which handles messages specific to channels. Usually this is just a
13547 * ChannelManager object or a ErroringMessageHandler.
13549 const struct LDKChannelMessageHandler *MessageHandler_get_chan_handler(const struct LDKMessageHandler *NONNULL_PTR this_ptr);
13552 * A message handler which handles messages specific to channels. Usually this is just a
13553 * ChannelManager object or a ErroringMessageHandler.
13555 void MessageHandler_set_chan_handler(struct LDKMessageHandler *NONNULL_PTR this_ptr, struct LDKChannelMessageHandler val);
13558 * A message handler which handles messages updating our knowledge of the network channel
13559 * graph. Usually this is just a NetGraphMsgHandlerMonitor object or an IgnoringMessageHandler.
13561 const struct LDKRoutingMessageHandler *MessageHandler_get_route_handler(const struct LDKMessageHandler *NONNULL_PTR this_ptr);
13564 * A message handler which handles messages updating our knowledge of the network channel
13565 * graph. Usually this is just a NetGraphMsgHandlerMonitor object or an IgnoringMessageHandler.
13567 void MessageHandler_set_route_handler(struct LDKMessageHandler *NONNULL_PTR this_ptr, struct LDKRoutingMessageHandler val);
13570 * Constructs a new MessageHandler given each field
13572 MUST_USE_RES struct LDKMessageHandler MessageHandler_new(struct LDKChannelMessageHandler chan_handler_arg, struct LDKRoutingMessageHandler route_handler_arg);
13575 * Creates a copy of a SocketDescriptor
13577 struct LDKSocketDescriptor SocketDescriptor_clone(const struct LDKSocketDescriptor *NONNULL_PTR orig);
13580 * Calls the free function if one is set
13582 void SocketDescriptor_free(struct LDKSocketDescriptor this_ptr);
13585 * Frees any resources used by the PeerHandleError, if is_owned is set and inner is non-NULL.
13587 void PeerHandleError_free(struct LDKPeerHandleError this_obj);
13590 * Used to indicate that we probably can't make any future connections to this peer, implying
13591 * we should go ahead and force-close any channels we have with it.
13593 bool PeerHandleError_get_no_connection_possible(const struct LDKPeerHandleError *NONNULL_PTR this_ptr);
13596 * Used to indicate that we probably can't make any future connections to this peer, implying
13597 * we should go ahead and force-close any channels we have with it.
13599 void PeerHandleError_set_no_connection_possible(struct LDKPeerHandleError *NONNULL_PTR this_ptr, bool val);
13602 * Constructs a new PeerHandleError given each field
13604 MUST_USE_RES struct LDKPeerHandleError PeerHandleError_new(bool no_connection_possible_arg);
13607 * Creates a copy of the PeerHandleError
13609 struct LDKPeerHandleError PeerHandleError_clone(const struct LDKPeerHandleError *NONNULL_PTR orig);
13612 * Frees any resources used by the PeerManager, if is_owned is set and inner is non-NULL.
13614 void PeerManager_free(struct LDKPeerManager this_obj);
13617 * Constructs a new PeerManager with the given message handlers and node_id secret key
13618 * ephemeral_random_data is used to derive per-connection ephemeral keys and must be
13619 * cryptographically secure random bytes.
13621 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);
13624 * Get the list of node ids for peers which have completed the initial handshake.
13626 * For outbound connections, this will be the same as the their_node_id parameter passed in to
13627 * new_outbound_connection, however entries will only appear once the initial handshake has
13628 * completed and we are sure the remote peer has the private key for the given node_id.
13630 MUST_USE_RES struct LDKCVec_PublicKeyZ PeerManager_get_peer_node_ids(const struct LDKPeerManager *NONNULL_PTR this_arg);
13633 * Indicates a new outbound connection has been established to a node with the given node_id.
13634 * Note that if an Err is returned here you MUST NOT call socket_disconnected for the new
13635 * descriptor but must disconnect the connection immediately.
13637 * Returns a small number of bytes to send to the remote node (currently always 50).
13639 * Panics if descriptor is duplicative with some other descriptor which has not yet had a
13640 * socket_disconnected().
13642 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);
13645 * Indicates a new inbound connection has been established.
13647 * May refuse the connection by returning an Err, but will never write bytes to the remote end
13648 * (outbound connector always speaks first). Note that if an Err is returned here you MUST NOT
13649 * call socket_disconnected for the new descriptor but must disconnect the connection
13652 * Panics if descriptor is duplicative with some other descriptor which has not yet had
13653 * socket_disconnected called.
13655 MUST_USE_RES struct LDKCResult_NonePeerHandleErrorZ PeerManager_new_inbound_connection(const struct LDKPeerManager *NONNULL_PTR this_arg, struct LDKSocketDescriptor descriptor);
13658 * Indicates that there is room to write data to the given socket descriptor.
13660 * May return an Err to indicate that the connection should be closed.
13662 * Will most likely call send_data on the descriptor passed in (or the descriptor handed into
13663 * new_*\\_connection) before returning. Thus, be very careful with reentrancy issues! The
13664 * invariants around calling write_buffer_space_avail in case a write did not fully complete
13665 * must still hold - be ready to call write_buffer_space_avail again if a write call generated
13666 * here isn't sufficient! Panics if the descriptor was not previously registered in a
13667 * new_\\*_connection event.
13669 MUST_USE_RES struct LDKCResult_NonePeerHandleErrorZ PeerManager_write_buffer_space_avail(const struct LDKPeerManager *NONNULL_PTR this_arg, struct LDKSocketDescriptor *NONNULL_PTR descriptor);
13672 * Indicates that data was read from the given socket descriptor.
13674 * May return an Err to indicate that the connection should be closed.
13676 * Will *not* call back into send_data on any descriptors to avoid reentrancy complexity.
13677 * Thus, however, you almost certainly want to call process_events() after any read_event to
13678 * generate send_data calls to handle responses.
13680 * If Ok(true) is returned, further read_events should not be triggered until a send_data call
13681 * on this file descriptor has resume_read set (preventing DoS issues in the send buffer).
13683 * Panics if the descriptor was not previously registered in a new_*_connection event.
13685 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);
13688 * Checks for any events generated by our handlers and processes them. Includes sending most
13689 * response messages as well as messages generated by calls to handler functions directly (eg
13690 * functions like ChannelManager::process_pending_htlc_forward or send_payment).
13692 void PeerManager_process_events(const struct LDKPeerManager *NONNULL_PTR this_arg);
13695 * Indicates that the given socket descriptor's connection is now closed.
13697 * This must only be called if the socket has been disconnected by the peer or your own
13698 * decision to disconnect it and must NOT be called in any case where other parts of this
13699 * library (eg PeerHandleError, explicit disconnect_socket calls) instruct you to disconnect
13702 * Panics if the descriptor was not previously registered in a successful new_*_connection event.
13704 void PeerManager_socket_disconnected(const struct LDKPeerManager *NONNULL_PTR this_arg, const struct LDKSocketDescriptor *NONNULL_PTR descriptor);
13707 * Disconnect a peer given its node id.
13709 * Set no_connection_possible to true to prevent any further connection with this peer,
13710 * force-closing any channels we have with it.
13712 * If a peer is connected, this will call `disconnect_socket` on the descriptor for the peer,
13713 * so be careful about reentrancy issues.
13715 void PeerManager_disconnect_by_node_id(const struct LDKPeerManager *NONNULL_PTR this_arg, struct LDKPublicKey node_id, bool no_connection_possible);
13718 * This function should be called roughly once every 30 seconds.
13719 * It will send pings to each peer and disconnect those which did not respond to the last round of pings.
13720 * Will most likely call send_data on all of the registered descriptors, thus, be very careful with reentrancy issues!
13722 void PeerManager_timer_tick_occurred(const struct LDKPeerManager *NONNULL_PTR this_arg);
13725 * Build the commitment secret from the seed and the commitment number
13727 struct LDKThirtyTwoBytes build_commitment_secret(const uint8_t (*commitment_seed)[32], uint64_t idx);
13730 * Derives a per-commitment-transaction private key (eg an htlc key or delayed_payment key)
13731 * from the base secret and the per_commitment_point.
13733 * Note that this is infallible iff we trust that at least one of the two input keys are randomly
13734 * generated (ie our own).
13736 struct LDKCResult_SecretKeyErrorZ derive_private_key(struct LDKPublicKey per_commitment_point, const uint8_t (*base_secret)[32]);
13739 * Derives a per-commitment-transaction public key (eg an htlc key or a delayed_payment key)
13740 * from the base point and the per_commitment_key. This is the public equivalent of
13741 * derive_private_key - using only public keys to derive a public key instead of private keys.
13743 * Note that this is infallible iff we trust that at least one of the two input keys are randomly
13744 * generated (ie our own).
13746 struct LDKCResult_PublicKeyErrorZ derive_public_key(struct LDKPublicKey per_commitment_point, struct LDKPublicKey base_point);
13749 * Derives a per-commitment-transaction revocation key from its constituent parts.
13751 * Only the cheating participant owns a valid witness to propagate a revoked
13752 * commitment transaction, thus per_commitment_secret always come from cheater
13753 * and revocation_base_secret always come from punisher, which is the broadcaster
13754 * of the transaction spending with this key knowledge.
13756 * Note that this is infallible iff we trust that at least one of the two input keys are randomly
13757 * generated (ie our own).
13759 struct LDKCResult_SecretKeyErrorZ derive_private_revocation_key(const uint8_t (*per_commitment_secret)[32], const uint8_t (*countersignatory_revocation_base_secret)[32]);
13762 * Derives a per-commitment-transaction revocation public key from its constituent parts. This is
13763 * the public equivalend of derive_private_revocation_key - using only public keys to derive a
13764 * public key instead of private keys.
13766 * Only the cheating participant owns a valid witness to propagate a revoked
13767 * commitment transaction, thus per_commitment_point always come from cheater
13768 * and revocation_base_point always come from punisher, which is the broadcaster
13769 * of the transaction spending with this key knowledge.
13771 * Note that this is infallible iff we trust that at least one of the two input keys are randomly
13772 * generated (ie our own).
13774 struct LDKCResult_PublicKeyErrorZ derive_public_revocation_key(struct LDKPublicKey per_commitment_point, struct LDKPublicKey countersignatory_revocation_base_point);
13777 * Frees any resources used by the TxCreationKeys, if is_owned is set and inner is non-NULL.
13779 void TxCreationKeys_free(struct LDKTxCreationKeys this_obj);
13782 * The broadcaster's per-commitment public key which was used to derive the other keys.
13784 struct LDKPublicKey TxCreationKeys_get_per_commitment_point(const struct LDKTxCreationKeys *NONNULL_PTR this_ptr);
13787 * The broadcaster's per-commitment public key which was used to derive the other keys.
13789 void TxCreationKeys_set_per_commitment_point(struct LDKTxCreationKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
13792 * The revocation key which is used to allow the broadcaster of the commitment
13793 * transaction to provide their counterparty the ability to punish them if they broadcast
13796 struct LDKPublicKey TxCreationKeys_get_revocation_key(const struct LDKTxCreationKeys *NONNULL_PTR this_ptr);
13799 * The revocation key which is used to allow the broadcaster of the commitment
13800 * transaction to provide their counterparty the ability to punish them if they broadcast
13803 void TxCreationKeys_set_revocation_key(struct LDKTxCreationKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
13806 * Broadcaster's HTLC Key
13808 struct LDKPublicKey TxCreationKeys_get_broadcaster_htlc_key(const struct LDKTxCreationKeys *NONNULL_PTR this_ptr);
13811 * Broadcaster's HTLC Key
13813 void TxCreationKeys_set_broadcaster_htlc_key(struct LDKTxCreationKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
13816 * Countersignatory's HTLC Key
13818 struct LDKPublicKey TxCreationKeys_get_countersignatory_htlc_key(const struct LDKTxCreationKeys *NONNULL_PTR this_ptr);
13821 * Countersignatory's HTLC Key
13823 void TxCreationKeys_set_countersignatory_htlc_key(struct LDKTxCreationKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
13826 * Broadcaster's Payment Key (which isn't allowed to be spent from for some delay)
13828 struct LDKPublicKey TxCreationKeys_get_broadcaster_delayed_payment_key(const struct LDKTxCreationKeys *NONNULL_PTR this_ptr);
13831 * Broadcaster's Payment Key (which isn't allowed to be spent from for some delay)
13833 void TxCreationKeys_set_broadcaster_delayed_payment_key(struct LDKTxCreationKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
13836 * Constructs a new TxCreationKeys given each field
13838 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);
13841 * Creates a copy of the TxCreationKeys
13843 struct LDKTxCreationKeys TxCreationKeys_clone(const struct LDKTxCreationKeys *NONNULL_PTR orig);
13846 * Serialize the TxCreationKeys object into a byte array which can be read by TxCreationKeys_read
13848 struct LDKCVec_u8Z TxCreationKeys_write(const struct LDKTxCreationKeys *NONNULL_PTR obj);
13851 * Read a TxCreationKeys from a byte array, created by TxCreationKeys_write
13853 struct LDKCResult_TxCreationKeysDecodeErrorZ TxCreationKeys_read(struct LDKu8slice ser);
13856 * Frees any resources used by the ChannelPublicKeys, if is_owned is set and inner is non-NULL.
13858 void ChannelPublicKeys_free(struct LDKChannelPublicKeys this_obj);
13861 * The public key which is used to sign all commitment transactions, as it appears in the
13862 * on-chain channel lock-in 2-of-2 multisig output.
13864 struct LDKPublicKey ChannelPublicKeys_get_funding_pubkey(const struct LDKChannelPublicKeys *NONNULL_PTR this_ptr);
13867 * The public key which is used to sign all commitment transactions, as it appears in the
13868 * on-chain channel lock-in 2-of-2 multisig output.
13870 void ChannelPublicKeys_set_funding_pubkey(struct LDKChannelPublicKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
13873 * The base point which is used (with derive_public_revocation_key) to derive per-commitment
13874 * revocation keys. This is combined with the per-commitment-secret generated by the
13875 * counterparty to create a secret which the counterparty can reveal to revoke previous
13878 struct LDKPublicKey ChannelPublicKeys_get_revocation_basepoint(const struct LDKChannelPublicKeys *NONNULL_PTR this_ptr);
13881 * The base point which is used (with derive_public_revocation_key) to derive per-commitment
13882 * revocation keys. This is combined with the per-commitment-secret generated by the
13883 * counterparty to create a secret which the counterparty can reveal to revoke previous
13886 void ChannelPublicKeys_set_revocation_basepoint(struct LDKChannelPublicKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
13889 * The public key on which the non-broadcaster (ie the countersignatory) receives an immediately
13890 * spendable primary channel balance on the broadcaster's commitment transaction. This key is
13891 * static across every commitment transaction.
13893 struct LDKPublicKey ChannelPublicKeys_get_payment_point(const struct LDKChannelPublicKeys *NONNULL_PTR this_ptr);
13896 * The public key on which the non-broadcaster (ie the countersignatory) receives an immediately
13897 * spendable primary channel balance on the broadcaster's commitment transaction. This key is
13898 * static across every commitment transaction.
13900 void ChannelPublicKeys_set_payment_point(struct LDKChannelPublicKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
13903 * The base point which is used (with derive_public_key) to derive a per-commitment payment
13904 * public key which receives non-HTLC-encumbered funds which are only available for spending
13905 * after some delay (or can be claimed via the revocation path).
13907 struct LDKPublicKey ChannelPublicKeys_get_delayed_payment_basepoint(const struct LDKChannelPublicKeys *NONNULL_PTR this_ptr);
13910 * The base point which is used (with derive_public_key) to derive a per-commitment payment
13911 * public key which receives non-HTLC-encumbered funds which are only available for spending
13912 * after some delay (or can be claimed via the revocation path).
13914 void ChannelPublicKeys_set_delayed_payment_basepoint(struct LDKChannelPublicKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
13917 * The base point which is used (with derive_public_key) to derive a per-commitment public key
13918 * which is used to encumber HTLC-in-flight outputs.
13920 struct LDKPublicKey ChannelPublicKeys_get_htlc_basepoint(const struct LDKChannelPublicKeys *NONNULL_PTR this_ptr);
13923 * The base point which is used (with derive_public_key) to derive a per-commitment public key
13924 * which is used to encumber HTLC-in-flight outputs.
13926 void ChannelPublicKeys_set_htlc_basepoint(struct LDKChannelPublicKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
13929 * Constructs a new ChannelPublicKeys given each field
13931 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);
13934 * Creates a copy of the ChannelPublicKeys
13936 struct LDKChannelPublicKeys ChannelPublicKeys_clone(const struct LDKChannelPublicKeys *NONNULL_PTR orig);
13939 * Serialize the ChannelPublicKeys object into a byte array which can be read by ChannelPublicKeys_read
13941 struct LDKCVec_u8Z ChannelPublicKeys_write(const struct LDKChannelPublicKeys *NONNULL_PTR obj);
13944 * Read a ChannelPublicKeys from a byte array, created by ChannelPublicKeys_write
13946 struct LDKCResult_ChannelPublicKeysDecodeErrorZ ChannelPublicKeys_read(struct LDKu8slice ser);
13949 * Create per-state keys from channel base points and the per-commitment point.
13950 * Key set is asymmetric and can't be used as part of counter-signatory set of transactions.
13952 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);
13955 * Generate per-state keys from channel static keys.
13956 * Key set is asymmetric and can't be used as part of counter-signatory set of transactions.
13958 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);
13961 * A script either spendable by the revocation
13962 * key or the broadcaster_delayed_payment_key and satisfying the relative-locktime OP_CSV constrain.
13963 * Encumbering a `to_holder` output on a commitment transaction or 2nd-stage HTLC transactions.
13965 struct LDKCVec_u8Z get_revokeable_redeemscript(struct LDKPublicKey revocation_key, uint16_t contest_delay, struct LDKPublicKey broadcaster_delayed_payment_key);
13968 * Frees any resources used by the HTLCOutputInCommitment, if is_owned is set and inner is non-NULL.
13970 void HTLCOutputInCommitment_free(struct LDKHTLCOutputInCommitment this_obj);
13973 * Whether the HTLC was \"offered\" (ie outbound in relation to this commitment transaction).
13974 * Note that this is not the same as whether it is ountbound *from us*. To determine that you
13975 * need to compare this value to whether the commitment transaction in question is that of
13976 * the counterparty or our own.
13978 bool HTLCOutputInCommitment_get_offered(const struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr);
13981 * Whether the HTLC was \"offered\" (ie outbound in relation to this commitment transaction).
13982 * Note that this is not the same as whether it is ountbound *from us*. To determine that you
13983 * need to compare this value to whether the commitment transaction in question is that of
13984 * the counterparty or our own.
13986 void HTLCOutputInCommitment_set_offered(struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr, bool val);
13989 * The value, in msat, of the HTLC. The value as it appears in the commitment transaction is
13990 * this divided by 1000.
13992 uint64_t HTLCOutputInCommitment_get_amount_msat(const struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr);
13995 * The value, in msat, of the HTLC. The value as it appears in the commitment transaction is
13996 * this divided by 1000.
13998 void HTLCOutputInCommitment_set_amount_msat(struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr, uint64_t val);
14001 * The CLTV lock-time at which this HTLC expires.
14003 uint32_t HTLCOutputInCommitment_get_cltv_expiry(const struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr);
14006 * The CLTV lock-time at which this HTLC expires.
14008 void HTLCOutputInCommitment_set_cltv_expiry(struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr, uint32_t val);
14011 * The hash of the preimage which unlocks this HTLC.
14013 const uint8_t (*HTLCOutputInCommitment_get_payment_hash(const struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr))[32];
14016 * The hash of the preimage which unlocks this HTLC.
14018 void HTLCOutputInCommitment_set_payment_hash(struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
14021 * The position within the commitment transactions' outputs. This may be None if the value is
14022 * below the dust limit (in which case no output appears in the commitment transaction and the
14023 * value is spent to additional transaction fees).
14025 struct LDKCOption_u32Z HTLCOutputInCommitment_get_transaction_output_index(const struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr);
14028 * The position within the commitment transactions' outputs. This may be None if the value is
14029 * below the dust limit (in which case no output appears in the commitment transaction and the
14030 * value is spent to additional transaction fees).
14032 void HTLCOutputInCommitment_set_transaction_output_index(struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr, struct LDKCOption_u32Z val);
14035 * Constructs a new HTLCOutputInCommitment given each field
14037 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);
14040 * Creates a copy of the HTLCOutputInCommitment
14042 struct LDKHTLCOutputInCommitment HTLCOutputInCommitment_clone(const struct LDKHTLCOutputInCommitment *NONNULL_PTR orig);
14045 * Serialize the HTLCOutputInCommitment object into a byte array which can be read by HTLCOutputInCommitment_read
14047 struct LDKCVec_u8Z HTLCOutputInCommitment_write(const struct LDKHTLCOutputInCommitment *NONNULL_PTR obj);
14050 * Read a HTLCOutputInCommitment from a byte array, created by HTLCOutputInCommitment_write
14052 struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ HTLCOutputInCommitment_read(struct LDKu8slice ser);
14055 * Gets the witness redeemscript for an HTLC output in a commitment transaction. Note that htlc
14056 * does not need to have its previous_output_index filled.
14058 struct LDKCVec_u8Z get_htlc_redeemscript(const struct LDKHTLCOutputInCommitment *NONNULL_PTR htlc, const struct LDKTxCreationKeys *NONNULL_PTR keys);
14061 * Gets the redeemscript for a funding output from the two funding public keys.
14062 * Note that the order of funding public keys does not matter.
14064 struct LDKCVec_u8Z make_funding_redeemscript(struct LDKPublicKey broadcaster, struct LDKPublicKey countersignatory);
14067 * panics if htlc.transaction_output_index.is_none()!
14069 struct LDKTransaction build_htlc_transaction(const uint8_t (*prev_hash)[32], uint32_t feerate_per_kw, uint16_t contest_delay, const struct LDKHTLCOutputInCommitment *NONNULL_PTR htlc, struct LDKPublicKey broadcaster_delayed_payment_key, struct LDKPublicKey revocation_key);
14072 * Frees any resources used by the ChannelTransactionParameters, if is_owned is set and inner is non-NULL.
14074 void ChannelTransactionParameters_free(struct LDKChannelTransactionParameters this_obj);
14077 * Holder public keys
14079 struct LDKChannelPublicKeys ChannelTransactionParameters_get_holder_pubkeys(const struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr);
14082 * Holder public keys
14084 void ChannelTransactionParameters_set_holder_pubkeys(struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr, struct LDKChannelPublicKeys val);
14087 * The contest delay selected by the holder, which applies to counterparty-broadcast transactions
14089 uint16_t ChannelTransactionParameters_get_holder_selected_contest_delay(const struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr);
14092 * The contest delay selected by the holder, which applies to counterparty-broadcast transactions
14094 void ChannelTransactionParameters_set_holder_selected_contest_delay(struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr, uint16_t val);
14097 * Whether the holder is the initiator of this channel.
14098 * This is an input to the commitment number obscure factor computation.
14100 bool ChannelTransactionParameters_get_is_outbound_from_holder(const struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr);
14103 * Whether the holder is the initiator of this channel.
14104 * This is an input to the commitment number obscure factor computation.
14106 void ChannelTransactionParameters_set_is_outbound_from_holder(struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr, bool val);
14109 * The late-bound counterparty channel transaction parameters.
14110 * These parameters are populated at the point in the protocol where the counterparty provides them.
14112 struct LDKCounterpartyChannelTransactionParameters ChannelTransactionParameters_get_counterparty_parameters(const struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr);
14115 * The late-bound counterparty channel transaction parameters.
14116 * These parameters are populated at the point in the protocol where the counterparty provides them.
14118 void ChannelTransactionParameters_set_counterparty_parameters(struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr, struct LDKCounterpartyChannelTransactionParameters val);
14121 * The late-bound funding outpoint
14123 struct LDKOutPoint ChannelTransactionParameters_get_funding_outpoint(const struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr);
14126 * The late-bound funding outpoint
14128 void ChannelTransactionParameters_set_funding_outpoint(struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr, struct LDKOutPoint val);
14131 * Constructs a new ChannelTransactionParameters given each field
14133 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);
14136 * Creates a copy of the ChannelTransactionParameters
14138 struct LDKChannelTransactionParameters ChannelTransactionParameters_clone(const struct LDKChannelTransactionParameters *NONNULL_PTR orig);
14141 * Frees any resources used by the CounterpartyChannelTransactionParameters, if is_owned is set and inner is non-NULL.
14143 void CounterpartyChannelTransactionParameters_free(struct LDKCounterpartyChannelTransactionParameters this_obj);
14146 * Counter-party public keys
14148 struct LDKChannelPublicKeys CounterpartyChannelTransactionParameters_get_pubkeys(const struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR this_ptr);
14151 * Counter-party public keys
14153 void CounterpartyChannelTransactionParameters_set_pubkeys(struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR this_ptr, struct LDKChannelPublicKeys val);
14156 * The contest delay selected by the counterparty, which applies to holder-broadcast transactions
14158 uint16_t CounterpartyChannelTransactionParameters_get_selected_contest_delay(const struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR this_ptr);
14161 * The contest delay selected by the counterparty, which applies to holder-broadcast transactions
14163 void CounterpartyChannelTransactionParameters_set_selected_contest_delay(struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR this_ptr, uint16_t val);
14166 * Constructs a new CounterpartyChannelTransactionParameters given each field
14168 MUST_USE_RES struct LDKCounterpartyChannelTransactionParameters CounterpartyChannelTransactionParameters_new(struct LDKChannelPublicKeys pubkeys_arg, uint16_t selected_contest_delay_arg);
14171 * Creates a copy of the CounterpartyChannelTransactionParameters
14173 struct LDKCounterpartyChannelTransactionParameters CounterpartyChannelTransactionParameters_clone(const struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR orig);
14176 * Whether the late bound parameters are populated.
14178 MUST_USE_RES bool ChannelTransactionParameters_is_populated(const struct LDKChannelTransactionParameters *NONNULL_PTR this_arg);
14181 * Convert the holder/counterparty parameters to broadcaster/countersignatory-organized parameters,
14182 * given that the holder is the broadcaster.
14184 * self.is_populated() must be true before calling this function.
14186 MUST_USE_RES struct LDKDirectedChannelTransactionParameters ChannelTransactionParameters_as_holder_broadcastable(const struct LDKChannelTransactionParameters *NONNULL_PTR this_arg);
14189 * Convert the holder/counterparty parameters to broadcaster/countersignatory-organized parameters,
14190 * given that the counterparty is the broadcaster.
14192 * self.is_populated() must be true before calling this function.
14194 MUST_USE_RES struct LDKDirectedChannelTransactionParameters ChannelTransactionParameters_as_counterparty_broadcastable(const struct LDKChannelTransactionParameters *NONNULL_PTR this_arg);
14197 * Serialize the CounterpartyChannelTransactionParameters object into a byte array which can be read by CounterpartyChannelTransactionParameters_read
14199 struct LDKCVec_u8Z CounterpartyChannelTransactionParameters_write(const struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR obj);
14202 * Read a CounterpartyChannelTransactionParameters from a byte array, created by CounterpartyChannelTransactionParameters_write
14204 struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ CounterpartyChannelTransactionParameters_read(struct LDKu8slice ser);
14207 * Serialize the ChannelTransactionParameters object into a byte array which can be read by ChannelTransactionParameters_read
14209 struct LDKCVec_u8Z ChannelTransactionParameters_write(const struct LDKChannelTransactionParameters *NONNULL_PTR obj);
14212 * Read a ChannelTransactionParameters from a byte array, created by ChannelTransactionParameters_write
14214 struct LDKCResult_ChannelTransactionParametersDecodeErrorZ ChannelTransactionParameters_read(struct LDKu8slice ser);
14217 * Frees any resources used by the DirectedChannelTransactionParameters, if is_owned is set and inner is non-NULL.
14219 void DirectedChannelTransactionParameters_free(struct LDKDirectedChannelTransactionParameters this_obj);
14222 * Get the channel pubkeys for the broadcaster
14224 MUST_USE_RES struct LDKChannelPublicKeys DirectedChannelTransactionParameters_broadcaster_pubkeys(const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR this_arg);
14227 * Get the channel pubkeys for the countersignatory
14229 MUST_USE_RES struct LDKChannelPublicKeys DirectedChannelTransactionParameters_countersignatory_pubkeys(const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR this_arg);
14232 * Get the contest delay applicable to the transactions.
14233 * Note that the contest delay was selected by the countersignatory.
14235 MUST_USE_RES uint16_t DirectedChannelTransactionParameters_contest_delay(const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR this_arg);
14238 * Whether the channel is outbound from the broadcaster.
14240 * The boolean representing the side that initiated the channel is
14241 * an input to the commitment number obscure factor computation.
14243 MUST_USE_RES bool DirectedChannelTransactionParameters_is_outbound(const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR this_arg);
14246 * The funding outpoint
14248 MUST_USE_RES struct LDKOutPoint DirectedChannelTransactionParameters_funding_outpoint(const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR this_arg);
14251 * Frees any resources used by the HolderCommitmentTransaction, if is_owned is set and inner is non-NULL.
14253 void HolderCommitmentTransaction_free(struct LDKHolderCommitmentTransaction this_obj);
14256 * Our counterparty's signature for the transaction
14258 struct LDKSignature HolderCommitmentTransaction_get_counterparty_sig(const struct LDKHolderCommitmentTransaction *NONNULL_PTR this_ptr);
14261 * Our counterparty's signature for the transaction
14263 void HolderCommitmentTransaction_set_counterparty_sig(struct LDKHolderCommitmentTransaction *NONNULL_PTR this_ptr, struct LDKSignature val);
14266 * All non-dust counterparty HTLC signatures, in the order they appear in the transaction
14268 void HolderCommitmentTransaction_set_counterparty_htlc_sigs(struct LDKHolderCommitmentTransaction *NONNULL_PTR this_ptr, struct LDKCVec_SignatureZ val);
14271 * Creates a copy of the HolderCommitmentTransaction
14273 struct LDKHolderCommitmentTransaction HolderCommitmentTransaction_clone(const struct LDKHolderCommitmentTransaction *NONNULL_PTR orig);
14276 * Serialize the HolderCommitmentTransaction object into a byte array which can be read by HolderCommitmentTransaction_read
14278 struct LDKCVec_u8Z HolderCommitmentTransaction_write(const struct LDKHolderCommitmentTransaction *NONNULL_PTR obj);
14281 * Read a HolderCommitmentTransaction from a byte array, created by HolderCommitmentTransaction_write
14283 struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ HolderCommitmentTransaction_read(struct LDKu8slice ser);
14286 * Create a new holder transaction with the given counterparty signatures.
14287 * The funding keys are used to figure out which signature should go first when building the transaction for broadcast.
14289 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);
14292 * Frees any resources used by the BuiltCommitmentTransaction, if is_owned is set and inner is non-NULL.
14294 void BuiltCommitmentTransaction_free(struct LDKBuiltCommitmentTransaction this_obj);
14297 * The commitment transaction
14299 struct LDKTransaction BuiltCommitmentTransaction_get_transaction(const struct LDKBuiltCommitmentTransaction *NONNULL_PTR this_ptr);
14302 * The commitment transaction
14304 void BuiltCommitmentTransaction_set_transaction(struct LDKBuiltCommitmentTransaction *NONNULL_PTR this_ptr, struct LDKTransaction val);
14307 * The txid for the commitment transaction.
14309 * This is provided as a performance optimization, instead of calling transaction.txid()
14312 const uint8_t (*BuiltCommitmentTransaction_get_txid(const struct LDKBuiltCommitmentTransaction *NONNULL_PTR this_ptr))[32];
14315 * The txid for the commitment transaction.
14317 * This is provided as a performance optimization, instead of calling transaction.txid()
14320 void BuiltCommitmentTransaction_set_txid(struct LDKBuiltCommitmentTransaction *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
14323 * Constructs a new BuiltCommitmentTransaction given each field
14325 MUST_USE_RES struct LDKBuiltCommitmentTransaction BuiltCommitmentTransaction_new(struct LDKTransaction transaction_arg, struct LDKThirtyTwoBytes txid_arg);
14328 * Creates a copy of the BuiltCommitmentTransaction
14330 struct LDKBuiltCommitmentTransaction BuiltCommitmentTransaction_clone(const struct LDKBuiltCommitmentTransaction *NONNULL_PTR orig);
14333 * Serialize the BuiltCommitmentTransaction object into a byte array which can be read by BuiltCommitmentTransaction_read
14335 struct LDKCVec_u8Z BuiltCommitmentTransaction_write(const struct LDKBuiltCommitmentTransaction *NONNULL_PTR obj);
14338 * Read a BuiltCommitmentTransaction from a byte array, created by BuiltCommitmentTransaction_write
14340 struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ BuiltCommitmentTransaction_read(struct LDKu8slice ser);
14343 * Get the SIGHASH_ALL sighash value of the transaction.
14345 * This can be used to verify a signature.
14347 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);
14350 * Sign a transaction, either because we are counter-signing the counterparty's transaction or
14351 * because we are about to broadcast a holder transaction.
14353 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);
14356 * Frees any resources used by the CommitmentTransaction, if is_owned is set and inner is non-NULL.
14358 void CommitmentTransaction_free(struct LDKCommitmentTransaction this_obj);
14361 * Creates a copy of the CommitmentTransaction
14363 struct LDKCommitmentTransaction CommitmentTransaction_clone(const struct LDKCommitmentTransaction *NONNULL_PTR orig);
14366 * Serialize the CommitmentTransaction object into a byte array which can be read by CommitmentTransaction_read
14368 struct LDKCVec_u8Z CommitmentTransaction_write(const struct LDKCommitmentTransaction *NONNULL_PTR obj);
14371 * Read a CommitmentTransaction from a byte array, created by CommitmentTransaction_write
14373 struct LDKCResult_CommitmentTransactionDecodeErrorZ CommitmentTransaction_read(struct LDKu8slice ser);
14376 * The backwards-counting commitment number
14378 MUST_USE_RES uint64_t CommitmentTransaction_commitment_number(const struct LDKCommitmentTransaction *NONNULL_PTR this_arg);
14381 * The value to be sent to the broadcaster
14383 MUST_USE_RES uint64_t CommitmentTransaction_to_broadcaster_value_sat(const struct LDKCommitmentTransaction *NONNULL_PTR this_arg);
14386 * The value to be sent to the counterparty
14388 MUST_USE_RES uint64_t CommitmentTransaction_to_countersignatory_value_sat(const struct LDKCommitmentTransaction *NONNULL_PTR this_arg);
14391 * The feerate paid per 1000-weight-unit in this commitment transaction.
14393 MUST_USE_RES uint32_t CommitmentTransaction_feerate_per_kw(const struct LDKCommitmentTransaction *NONNULL_PTR this_arg);
14396 * Trust our pre-built transaction and derived transaction creation public keys.
14398 * Applies a wrapper which allows access to these fields.
14400 * This should only be used if you fully trust the builder of this object. It should not
14401 *\tbe used by an external signer - instead use the verify function.
14403 MUST_USE_RES struct LDKTrustedCommitmentTransaction CommitmentTransaction_trust(const struct LDKCommitmentTransaction *NONNULL_PTR this_arg);
14406 * Verify our pre-built transaction and derived transaction creation public keys.
14408 * Applies a wrapper which allows access to these fields.
14410 * An external validating signer must call this method before signing
14411 * or using the built transaction.
14413 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);
14416 * Frees any resources used by the TrustedCommitmentTransaction, if is_owned is set and inner is non-NULL.
14418 void TrustedCommitmentTransaction_free(struct LDKTrustedCommitmentTransaction this_obj);
14421 * The transaction ID of the built Bitcoin transaction
14423 MUST_USE_RES struct LDKThirtyTwoBytes TrustedCommitmentTransaction_txid(const struct LDKTrustedCommitmentTransaction *NONNULL_PTR this_arg);
14426 * The pre-built Bitcoin commitment transaction
14428 MUST_USE_RES struct LDKBuiltCommitmentTransaction TrustedCommitmentTransaction_built_transaction(const struct LDKTrustedCommitmentTransaction *NONNULL_PTR this_arg);
14431 * The pre-calculated transaction creation public keys.
14433 MUST_USE_RES struct LDKTxCreationKeys TrustedCommitmentTransaction_keys(const struct LDKTrustedCommitmentTransaction *NONNULL_PTR this_arg);
14436 * Get a signature for each HTLC which was included in the commitment transaction (ie for
14437 * which HTLCOutputInCommitment::transaction_output_index.is_some()).
14439 * The returned Vec has one entry for each HTLC, and in the same order.
14441 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);
14444 * Get the transaction number obscure factor
14446 uint64_t get_commitment_transaction_number_obscure_factor(struct LDKPublicKey broadcaster_payment_basepoint, struct LDKPublicKey countersignatory_payment_basepoint, bool outbound_from_broadcaster);
14449 * Creates a copy of the InitFeatures
14451 struct LDKInitFeatures InitFeatures_clone(const struct LDKInitFeatures *NONNULL_PTR orig);
14454 * Creates a copy of the NodeFeatures
14456 struct LDKNodeFeatures NodeFeatures_clone(const struct LDKNodeFeatures *NONNULL_PTR orig);
14459 * Creates a copy of the ChannelFeatures
14461 struct LDKChannelFeatures ChannelFeatures_clone(const struct LDKChannelFeatures *NONNULL_PTR orig);
14464 * Creates a copy of the InvoiceFeatures
14466 struct LDKInvoiceFeatures InvoiceFeatures_clone(const struct LDKInvoiceFeatures *NONNULL_PTR orig);
14469 * Frees any resources used by the InitFeatures, if is_owned is set and inner is non-NULL.
14471 void InitFeatures_free(struct LDKInitFeatures this_obj);
14474 * Frees any resources used by the NodeFeatures, if is_owned is set and inner is non-NULL.
14476 void NodeFeatures_free(struct LDKNodeFeatures this_obj);
14479 * Frees any resources used by the ChannelFeatures, if is_owned is set and inner is non-NULL.
14481 void ChannelFeatures_free(struct LDKChannelFeatures this_obj);
14484 * Frees any resources used by the InvoiceFeatures, if is_owned is set and inner is non-NULL.
14486 void InvoiceFeatures_free(struct LDKInvoiceFeatures this_obj);
14489 * Create a blank Features with no features set
14491 MUST_USE_RES struct LDKInitFeatures InitFeatures_empty(void);
14494 * Creates a Features with the bits set which are known by the implementation
14496 MUST_USE_RES struct LDKInitFeatures InitFeatures_known(void);
14499 * Create a blank Features with no features set
14501 MUST_USE_RES struct LDKNodeFeatures NodeFeatures_empty(void);
14504 * Creates a Features with the bits set which are known by the implementation
14506 MUST_USE_RES struct LDKNodeFeatures NodeFeatures_known(void);
14509 * Create a blank Features with no features set
14511 MUST_USE_RES struct LDKChannelFeatures ChannelFeatures_empty(void);
14514 * Creates a Features with the bits set which are known by the implementation
14516 MUST_USE_RES struct LDKChannelFeatures ChannelFeatures_known(void);
14519 * Create a blank Features with no features set
14521 MUST_USE_RES struct LDKInvoiceFeatures InvoiceFeatures_empty(void);
14524 * Creates a Features with the bits set which are known by the implementation
14526 MUST_USE_RES struct LDKInvoiceFeatures InvoiceFeatures_known(void);
14529 * Serialize the InitFeatures object into a byte array which can be read by InitFeatures_read
14531 struct LDKCVec_u8Z InitFeatures_write(const struct LDKInitFeatures *NONNULL_PTR obj);
14534 * Serialize the NodeFeatures object into a byte array which can be read by NodeFeatures_read
14536 struct LDKCVec_u8Z NodeFeatures_write(const struct LDKNodeFeatures *NONNULL_PTR obj);
14539 * Serialize the ChannelFeatures object into a byte array which can be read by ChannelFeatures_read
14541 struct LDKCVec_u8Z ChannelFeatures_write(const struct LDKChannelFeatures *NONNULL_PTR obj);
14544 * Serialize the InvoiceFeatures object into a byte array which can be read by InvoiceFeatures_read
14546 struct LDKCVec_u8Z InvoiceFeatures_write(const struct LDKInvoiceFeatures *NONNULL_PTR obj);
14549 * Read a InitFeatures from a byte array, created by InitFeatures_write
14551 struct LDKCResult_InitFeaturesDecodeErrorZ InitFeatures_read(struct LDKu8slice ser);
14554 * Read a NodeFeatures from a byte array, created by NodeFeatures_write
14556 struct LDKCResult_NodeFeaturesDecodeErrorZ NodeFeatures_read(struct LDKu8slice ser);
14559 * Read a ChannelFeatures from a byte array, created by ChannelFeatures_write
14561 struct LDKCResult_ChannelFeaturesDecodeErrorZ ChannelFeatures_read(struct LDKu8slice ser);
14564 * Read a InvoiceFeatures from a byte array, created by InvoiceFeatures_write
14566 struct LDKCResult_InvoiceFeaturesDecodeErrorZ InvoiceFeatures_read(struct LDKu8slice ser);
14569 * Frees any resources used by the RouteHop, if is_owned is set and inner is non-NULL.
14571 void RouteHop_free(struct LDKRouteHop this_obj);
14574 * The node_id of the node at this hop.
14576 struct LDKPublicKey RouteHop_get_pubkey(const struct LDKRouteHop *NONNULL_PTR this_ptr);
14579 * The node_id of the node at this hop.
14581 void RouteHop_set_pubkey(struct LDKRouteHop *NONNULL_PTR this_ptr, struct LDKPublicKey val);
14584 * The node_announcement features of the node at this hop. For the last hop, these may be
14585 * amended to match the features present in the invoice this node generated.
14587 struct LDKNodeFeatures RouteHop_get_node_features(const struct LDKRouteHop *NONNULL_PTR this_ptr);
14590 * The node_announcement features of the node at this hop. For the last hop, these may be
14591 * amended to match the features present in the invoice this node generated.
14593 void RouteHop_set_node_features(struct LDKRouteHop *NONNULL_PTR this_ptr, struct LDKNodeFeatures val);
14596 * The channel that should be used from the previous hop to reach this node.
14598 uint64_t RouteHop_get_short_channel_id(const struct LDKRouteHop *NONNULL_PTR this_ptr);
14601 * The channel that should be used from the previous hop to reach this node.
14603 void RouteHop_set_short_channel_id(struct LDKRouteHop *NONNULL_PTR this_ptr, uint64_t val);
14606 * The channel_announcement features of the channel that should be used from the previous hop
14607 * to reach this node.
14609 struct LDKChannelFeatures RouteHop_get_channel_features(const struct LDKRouteHop *NONNULL_PTR this_ptr);
14612 * The channel_announcement features of the channel that should be used from the previous hop
14613 * to reach this node.
14615 void RouteHop_set_channel_features(struct LDKRouteHop *NONNULL_PTR this_ptr, struct LDKChannelFeatures val);
14618 * The fee taken on this hop (for paying for the use of the *next* channel in the path).
14619 * For the last hop, this should be the full value of the payment (might be more than
14620 * requested if we had to match htlc_minimum_msat).
14622 uint64_t RouteHop_get_fee_msat(const struct LDKRouteHop *NONNULL_PTR this_ptr);
14625 * The fee taken on this hop (for paying for the use of the *next* channel in the path).
14626 * For the last hop, this should be the full value of the payment (might be more than
14627 * requested if we had to match htlc_minimum_msat).
14629 void RouteHop_set_fee_msat(struct LDKRouteHop *NONNULL_PTR this_ptr, uint64_t val);
14632 * The CLTV delta added for this hop. For the last hop, this should be the full CLTV value
14633 * expected at the destination, in excess of the current block height.
14635 uint32_t RouteHop_get_cltv_expiry_delta(const struct LDKRouteHop *NONNULL_PTR this_ptr);
14638 * The CLTV delta added for this hop. For the last hop, this should be the full CLTV value
14639 * expected at the destination, in excess of the current block height.
14641 void RouteHop_set_cltv_expiry_delta(struct LDKRouteHop *NONNULL_PTR this_ptr, uint32_t val);
14644 * Constructs a new RouteHop given each field
14646 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);
14649 * Creates a copy of the RouteHop
14651 struct LDKRouteHop RouteHop_clone(const struct LDKRouteHop *NONNULL_PTR orig);
14654 * Frees any resources used by the Route, if is_owned is set and inner is non-NULL.
14656 void Route_free(struct LDKRoute this_obj);
14659 * The list of routes taken for a single (potentially-)multi-part payment. The pubkey of the
14660 * last RouteHop in each path must be the same.
14661 * Each entry represents a list of hops, NOT INCLUDING our own, where the last hop is the
14662 * destination. Thus, this must always be at least length one. While the maximum length of any
14663 * given path is variable, keeping the length of any path to less than 20 should currently
14664 * ensure it is viable.
14666 void Route_set_paths(struct LDKRoute *NONNULL_PTR this_ptr, struct LDKCVec_CVec_RouteHopZZ val);
14669 * Constructs a new Route given each field
14671 MUST_USE_RES struct LDKRoute Route_new(struct LDKCVec_CVec_RouteHopZZ paths_arg);
14674 * Creates a copy of the Route
14676 struct LDKRoute Route_clone(const struct LDKRoute *NONNULL_PTR orig);
14679 * Serialize the Route object into a byte array which can be read by Route_read
14681 struct LDKCVec_u8Z Route_write(const struct LDKRoute *NONNULL_PTR obj);
14684 * Read a Route from a byte array, created by Route_write
14686 struct LDKCResult_RouteDecodeErrorZ Route_read(struct LDKu8slice ser);
14689 * Frees any resources used by the RouteHint, if is_owned is set and inner is non-NULL.
14691 void RouteHint_free(struct LDKRouteHint this_obj);
14694 * The node_id of the non-target end of the route
14696 struct LDKPublicKey RouteHint_get_src_node_id(const struct LDKRouteHint *NONNULL_PTR this_ptr);
14699 * The node_id of the non-target end of the route
14701 void RouteHint_set_src_node_id(struct LDKRouteHint *NONNULL_PTR this_ptr, struct LDKPublicKey val);
14704 * The short_channel_id of this channel
14706 uint64_t RouteHint_get_short_channel_id(const struct LDKRouteHint *NONNULL_PTR this_ptr);
14709 * The short_channel_id of this channel
14711 void RouteHint_set_short_channel_id(struct LDKRouteHint *NONNULL_PTR this_ptr, uint64_t val);
14714 * The fees which must be paid to use this channel
14716 struct LDKRoutingFees RouteHint_get_fees(const struct LDKRouteHint *NONNULL_PTR this_ptr);
14719 * The fees which must be paid to use this channel
14721 void RouteHint_set_fees(struct LDKRouteHint *NONNULL_PTR this_ptr, struct LDKRoutingFees val);
14724 * The difference in CLTV values between this node and the next node.
14726 uint16_t RouteHint_get_cltv_expiry_delta(const struct LDKRouteHint *NONNULL_PTR this_ptr);
14729 * The difference in CLTV values between this node and the next node.
14731 void RouteHint_set_cltv_expiry_delta(struct LDKRouteHint *NONNULL_PTR this_ptr, uint16_t val);
14734 * The minimum value, in msat, which must be relayed to the next hop.
14736 struct LDKCOption_u64Z RouteHint_get_htlc_minimum_msat(const struct LDKRouteHint *NONNULL_PTR this_ptr);
14739 * The minimum value, in msat, which must be relayed to the next hop.
14741 void RouteHint_set_htlc_minimum_msat(struct LDKRouteHint *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
14744 * The maximum value in msat available for routing with a single HTLC.
14746 struct LDKCOption_u64Z RouteHint_get_htlc_maximum_msat(const struct LDKRouteHint *NONNULL_PTR this_ptr);
14749 * The maximum value in msat available for routing with a single HTLC.
14751 void RouteHint_set_htlc_maximum_msat(struct LDKRouteHint *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
14754 * Constructs a new RouteHint given each field
14756 MUST_USE_RES struct LDKRouteHint RouteHint_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);
14759 * Creates a copy of the RouteHint
14761 struct LDKRouteHint RouteHint_clone(const struct LDKRouteHint *NONNULL_PTR orig);
14764 * Gets a route from us (payer) to the given target node (payee).
14766 * If the payee provided features in their invoice, they should be provided via payee_features.
14767 * Without this, MPP will only be used if the payee's features are available in the network graph.
14769 * Extra routing hops between known nodes and the target will be used if they are included in
14772 * If some channels aren't announced, it may be useful to fill in a first_hops with the
14773 * results from a local ChannelManager::list_usable_channels() call. If it is filled in, our
14774 * view of our local channels (from net_graph_msg_handler) will be ignored, and only those
14775 * in first_hops will be used.
14777 * Panics if first_hops contains channels without short_channel_ids
14778 * (ChannelManager::list_usable_channels will never include such channels).
14780 * The fees on channels from us to next-hops are ignored (as they are assumed to all be
14781 * equal), however the enabled/disabled bit on such channels as well as the
14782 * htlc_minimum_msat/htlc_maximum_msat *are* checked as they may change based on the receiving node.
14784 struct LDKCResult_RouteLightningErrorZ get_route(struct LDKPublicKey our_node_id, const struct LDKNetworkGraph *NONNULL_PTR network, struct LDKPublicKey payee, struct LDKInvoiceFeatures payee_features, struct LDKCVec_ChannelDetailsZ *first_hops, struct LDKCVec_RouteHintZ last_hops, uint64_t final_value_msat, uint32_t final_cltv, struct LDKLogger logger);
14787 * Frees any resources used by the NetworkGraph, if is_owned is set and inner is non-NULL.
14789 void NetworkGraph_free(struct LDKNetworkGraph this_obj);
14792 * Creates a copy of the NetworkGraph
14794 struct LDKNetworkGraph NetworkGraph_clone(const struct LDKNetworkGraph *NONNULL_PTR orig);
14797 * Frees any resources used by the LockedNetworkGraph, if is_owned is set and inner is non-NULL.
14799 void LockedNetworkGraph_free(struct LDKLockedNetworkGraph this_obj);
14802 * Frees any resources used by the NetGraphMsgHandler, if is_owned is set and inner is non-NULL.
14804 void NetGraphMsgHandler_free(struct LDKNetGraphMsgHandler this_obj);
14807 * Creates a new tracker of the actual state of the network of channels and nodes,
14808 * assuming a fresh network graph.
14809 * Chain monitor is used to make sure announced channels exist on-chain,
14810 * channel data is correct, and that the announcement is signed with
14811 * channel owners' keys.
14813 MUST_USE_RES struct LDKNetGraphMsgHandler NetGraphMsgHandler_new(struct LDKThirtyTwoBytes genesis_hash, struct LDKAccess *chain_access, struct LDKLogger logger);
14816 * Creates a new tracker of the actual state of the network of channels and nodes,
14817 * assuming an existing Network Graph.
14819 MUST_USE_RES struct LDKNetGraphMsgHandler NetGraphMsgHandler_from_net_graph(struct LDKAccess *chain_access, struct LDKLogger logger, struct LDKNetworkGraph network_graph);
14822 * Adds a provider used to check new announcements. Does not affect
14823 * existing announcements unless they are updated.
14824 * Add, update or remove the provider would replace the current one.
14826 void NetGraphMsgHandler_add_chain_access(struct LDKNetGraphMsgHandler *NONNULL_PTR this_arg, struct LDKAccess *chain_access);
14829 * Take a read lock on the network_graph and return it in the C-bindings
14830 * newtype helper. This is likely only useful when called via the C
14831 * bindings as you can call `self.network_graph.read().unwrap()` in Rust
14834 MUST_USE_RES struct LDKLockedNetworkGraph NetGraphMsgHandler_read_locked_graph(const struct LDKNetGraphMsgHandler *NONNULL_PTR this_arg);
14837 * Get a reference to the NetworkGraph which this read-lock contains.
14839 MUST_USE_RES struct LDKNetworkGraph LockedNetworkGraph_graph(const struct LDKLockedNetworkGraph *NONNULL_PTR this_arg);
14842 * Constructs a new RoutingMessageHandler which calls the relevant methods on this_arg.
14843 * This copies the `inner` pointer in this_arg and thus the returned RoutingMessageHandler must be freed before this_arg is
14845 struct LDKRoutingMessageHandler NetGraphMsgHandler_as_RoutingMessageHandler(const struct LDKNetGraphMsgHandler *NONNULL_PTR this_arg);
14848 * Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
14849 * This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
14851 struct LDKMessageSendEventsProvider NetGraphMsgHandler_as_MessageSendEventsProvider(const struct LDKNetGraphMsgHandler *NONNULL_PTR this_arg);
14854 * Frees any resources used by the DirectionalChannelInfo, if is_owned is set and inner is non-NULL.
14856 void DirectionalChannelInfo_free(struct LDKDirectionalChannelInfo this_obj);
14859 * When the last update to the channel direction was issued.
14860 * Value is opaque, as set in the announcement.
14862 uint32_t DirectionalChannelInfo_get_last_update(const struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr);
14865 * When the last update to the channel direction was issued.
14866 * Value is opaque, as set in the announcement.
14868 void DirectionalChannelInfo_set_last_update(struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr, uint32_t val);
14871 * Whether the channel can be currently used for payments (in this one direction).
14873 bool DirectionalChannelInfo_get_enabled(const struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr);
14876 * Whether the channel can be currently used for payments (in this one direction).
14878 void DirectionalChannelInfo_set_enabled(struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr, bool val);
14881 * The difference in CLTV values that you must have when routing through this channel.
14883 uint16_t DirectionalChannelInfo_get_cltv_expiry_delta(const struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr);
14886 * The difference in CLTV values that you must have when routing through this channel.
14888 void DirectionalChannelInfo_set_cltv_expiry_delta(struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr, uint16_t val);
14891 * The minimum value, which must be relayed to the next hop via the channel
14893 uint64_t DirectionalChannelInfo_get_htlc_minimum_msat(const struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr);
14896 * The minimum value, which must be relayed to the next hop via the channel
14898 void DirectionalChannelInfo_set_htlc_minimum_msat(struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr, uint64_t val);
14901 * The maximum value which may be relayed to the next hop via the channel.
14903 struct LDKCOption_u64Z DirectionalChannelInfo_get_htlc_maximum_msat(const struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr);
14906 * The maximum value which may be relayed to the next hop via the channel.
14908 void DirectionalChannelInfo_set_htlc_maximum_msat(struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
14911 * Fees charged when the channel is used for routing
14913 struct LDKRoutingFees DirectionalChannelInfo_get_fees(const struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr);
14916 * Fees charged when the channel is used for routing
14918 void DirectionalChannelInfo_set_fees(struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr, struct LDKRoutingFees val);
14921 * Most recent update for the channel received from the network
14922 * Mostly redundant with the data we store in fields explicitly.
14923 * Everything else is useful only for sending out for initial routing sync.
14924 * Not stored if contains excess data to prevent DoS.
14926 struct LDKChannelUpdate DirectionalChannelInfo_get_last_update_message(const struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr);
14929 * Most recent update for the channel received from the network
14930 * Mostly redundant with the data we store in fields explicitly.
14931 * Everything else is useful only for sending out for initial routing sync.
14932 * Not stored if contains excess data to prevent DoS.
14934 void DirectionalChannelInfo_set_last_update_message(struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr, struct LDKChannelUpdate val);
14937 * Constructs a new DirectionalChannelInfo given each field
14939 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);
14942 * Creates a copy of the DirectionalChannelInfo
14944 struct LDKDirectionalChannelInfo DirectionalChannelInfo_clone(const struct LDKDirectionalChannelInfo *NONNULL_PTR orig);
14947 * Serialize the DirectionalChannelInfo object into a byte array which can be read by DirectionalChannelInfo_read
14949 struct LDKCVec_u8Z DirectionalChannelInfo_write(const struct LDKDirectionalChannelInfo *NONNULL_PTR obj);
14952 * Read a DirectionalChannelInfo from a byte array, created by DirectionalChannelInfo_write
14954 struct LDKCResult_DirectionalChannelInfoDecodeErrorZ DirectionalChannelInfo_read(struct LDKu8slice ser);
14957 * Frees any resources used by the ChannelInfo, if is_owned is set and inner is non-NULL.
14959 void ChannelInfo_free(struct LDKChannelInfo this_obj);
14962 * Protocol features of a channel communicated during its announcement
14964 struct LDKChannelFeatures ChannelInfo_get_features(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
14967 * Protocol features of a channel communicated during its announcement
14969 void ChannelInfo_set_features(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKChannelFeatures val);
14972 * Source node of the first direction of a channel
14974 struct LDKPublicKey ChannelInfo_get_node_one(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
14977 * Source node of the first direction of a channel
14979 void ChannelInfo_set_node_one(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKPublicKey val);
14982 * Details about the first direction of a channel
14984 struct LDKDirectionalChannelInfo ChannelInfo_get_one_to_two(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
14987 * Details about the first direction of a channel
14989 void ChannelInfo_set_one_to_two(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKDirectionalChannelInfo val);
14992 * Source node of the second direction of a channel
14994 struct LDKPublicKey ChannelInfo_get_node_two(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
14997 * Source node of the second direction of a channel
14999 void ChannelInfo_set_node_two(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKPublicKey val);
15002 * Details about the second direction of a channel
15004 struct LDKDirectionalChannelInfo ChannelInfo_get_two_to_one(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
15007 * Details about the second direction of a channel
15009 void ChannelInfo_set_two_to_one(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKDirectionalChannelInfo val);
15012 * The channel capacity as seen on-chain, if chain lookup is available.
15014 struct LDKCOption_u64Z ChannelInfo_get_capacity_sats(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
15017 * The channel capacity as seen on-chain, if chain lookup is available.
15019 void ChannelInfo_set_capacity_sats(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
15022 * An initial announcement of the channel
15023 * Mostly redundant with the data we store in fields explicitly.
15024 * Everything else is useful only for sending out for initial routing sync.
15025 * Not stored if contains excess data to prevent DoS.
15027 struct LDKChannelAnnouncement ChannelInfo_get_announcement_message(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
15030 * An initial announcement of the channel
15031 * Mostly redundant with the data we store in fields explicitly.
15032 * Everything else is useful only for sending out for initial routing sync.
15033 * Not stored if contains excess data to prevent DoS.
15035 void ChannelInfo_set_announcement_message(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKChannelAnnouncement val);
15038 * Constructs a new ChannelInfo given each field
15040 MUST_USE_RES struct LDKChannelInfo ChannelInfo_new(struct LDKChannelFeatures features_arg, struct LDKPublicKey node_one_arg, struct LDKDirectionalChannelInfo one_to_two_arg, struct LDKPublicKey node_two_arg, struct LDKDirectionalChannelInfo two_to_one_arg, struct LDKCOption_u64Z capacity_sats_arg, struct LDKChannelAnnouncement announcement_message_arg);
15043 * Creates a copy of the ChannelInfo
15045 struct LDKChannelInfo ChannelInfo_clone(const struct LDKChannelInfo *NONNULL_PTR orig);
15048 * Serialize the ChannelInfo object into a byte array which can be read by ChannelInfo_read
15050 struct LDKCVec_u8Z ChannelInfo_write(const struct LDKChannelInfo *NONNULL_PTR obj);
15053 * Read a ChannelInfo from a byte array, created by ChannelInfo_write
15055 struct LDKCResult_ChannelInfoDecodeErrorZ ChannelInfo_read(struct LDKu8slice ser);
15058 * Frees any resources used by the RoutingFees, if is_owned is set and inner is non-NULL.
15060 void RoutingFees_free(struct LDKRoutingFees this_obj);
15063 * Flat routing fee in satoshis
15065 uint32_t RoutingFees_get_base_msat(const struct LDKRoutingFees *NONNULL_PTR this_ptr);
15068 * Flat routing fee in satoshis
15070 void RoutingFees_set_base_msat(struct LDKRoutingFees *NONNULL_PTR this_ptr, uint32_t val);
15073 * Liquidity-based routing fee in millionths of a routed amount.
15074 * In other words, 10000 is 1%.
15076 uint32_t RoutingFees_get_proportional_millionths(const struct LDKRoutingFees *NONNULL_PTR this_ptr);
15079 * Liquidity-based routing fee in millionths of a routed amount.
15080 * In other words, 10000 is 1%.
15082 void RoutingFees_set_proportional_millionths(struct LDKRoutingFees *NONNULL_PTR this_ptr, uint32_t val);
15085 * Constructs a new RoutingFees given each field
15087 MUST_USE_RES struct LDKRoutingFees RoutingFees_new(uint32_t base_msat_arg, uint32_t proportional_millionths_arg);
15090 * Creates a copy of the RoutingFees
15092 struct LDKRoutingFees RoutingFees_clone(const struct LDKRoutingFees *NONNULL_PTR orig);
15095 * Read a RoutingFees from a byte array, created by RoutingFees_write
15097 struct LDKCResult_RoutingFeesDecodeErrorZ RoutingFees_read(struct LDKu8slice ser);
15100 * Serialize the RoutingFees object into a byte array which can be read by RoutingFees_read
15102 struct LDKCVec_u8Z RoutingFees_write(const struct LDKRoutingFees *NONNULL_PTR obj);
15105 * Frees any resources used by the NodeAnnouncementInfo, if is_owned is set and inner is non-NULL.
15107 void NodeAnnouncementInfo_free(struct LDKNodeAnnouncementInfo this_obj);
15110 * Protocol features the node announced support for
15112 struct LDKNodeFeatures NodeAnnouncementInfo_get_features(const struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr);
15115 * Protocol features the node announced support for
15117 void NodeAnnouncementInfo_set_features(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, struct LDKNodeFeatures val);
15120 * When the last known update to the node state was issued.
15121 * Value is opaque, as set in the announcement.
15123 uint32_t NodeAnnouncementInfo_get_last_update(const struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr);
15126 * When the last known update to the node state was issued.
15127 * Value is opaque, as set in the announcement.
15129 void NodeAnnouncementInfo_set_last_update(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, uint32_t val);
15132 * Color assigned to the node
15134 const uint8_t (*NodeAnnouncementInfo_get_rgb(const struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr))[3];
15137 * Color assigned to the node
15139 void NodeAnnouncementInfo_set_rgb(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, struct LDKThreeBytes val);
15142 * Moniker assigned to the node.
15143 * May be invalid or malicious (eg control chars),
15144 * should not be exposed to the user.
15146 const uint8_t (*NodeAnnouncementInfo_get_alias(const struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr))[32];
15149 * Moniker assigned to the node.
15150 * May be invalid or malicious (eg control chars),
15151 * should not be exposed to the user.
15153 void NodeAnnouncementInfo_set_alias(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
15156 * Internet-level addresses via which one can connect to the node
15158 void NodeAnnouncementInfo_set_addresses(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, struct LDKCVec_NetAddressZ val);
15161 * An initial announcement of the node
15162 * Mostly redundant with the data we store in fields explicitly.
15163 * Everything else is useful only for sending out for initial routing sync.
15164 * Not stored if contains excess data to prevent DoS.
15166 struct LDKNodeAnnouncement NodeAnnouncementInfo_get_announcement_message(const struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr);
15169 * An initial announcement of the node
15170 * Mostly redundant with the data we store in fields explicitly.
15171 * Everything else is useful only for sending out for initial routing sync.
15172 * Not stored if contains excess data to prevent DoS.
15174 void NodeAnnouncementInfo_set_announcement_message(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, struct LDKNodeAnnouncement val);
15177 * Constructs a new NodeAnnouncementInfo given each field
15179 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);
15182 * Creates a copy of the NodeAnnouncementInfo
15184 struct LDKNodeAnnouncementInfo NodeAnnouncementInfo_clone(const struct LDKNodeAnnouncementInfo *NONNULL_PTR orig);
15187 * Serialize the NodeAnnouncementInfo object into a byte array which can be read by NodeAnnouncementInfo_read
15189 struct LDKCVec_u8Z NodeAnnouncementInfo_write(const struct LDKNodeAnnouncementInfo *NONNULL_PTR obj);
15192 * Read a NodeAnnouncementInfo from a byte array, created by NodeAnnouncementInfo_write
15194 struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ NodeAnnouncementInfo_read(struct LDKu8slice ser);
15197 * Frees any resources used by the NodeInfo, if is_owned is set and inner is non-NULL.
15199 void NodeInfo_free(struct LDKNodeInfo this_obj);
15202 * All valid channels a node has announced
15204 void NodeInfo_set_channels(struct LDKNodeInfo *NONNULL_PTR this_ptr, struct LDKCVec_u64Z val);
15207 * Lowest fees enabling routing via any of the enabled, known channels to a node.
15208 * The two fields (flat and proportional fee) are independent,
15209 * meaning they don't have to refer to the same channel.
15211 struct LDKRoutingFees NodeInfo_get_lowest_inbound_channel_fees(const struct LDKNodeInfo *NONNULL_PTR this_ptr);
15214 * Lowest fees enabling routing via any of the enabled, known channels to a node.
15215 * The two fields (flat and proportional fee) are independent,
15216 * meaning they don't have to refer to the same channel.
15218 void NodeInfo_set_lowest_inbound_channel_fees(struct LDKNodeInfo *NONNULL_PTR this_ptr, struct LDKRoutingFees val);
15221 * More information about a node from node_announcement.
15222 * Optional because we store a Node entry after learning about it from
15223 * a channel announcement, but before receiving a node announcement.
15225 struct LDKNodeAnnouncementInfo NodeInfo_get_announcement_info(const struct LDKNodeInfo *NONNULL_PTR this_ptr);
15228 * More information about a node from node_announcement.
15229 * Optional because we store a Node entry after learning about it from
15230 * a channel announcement, but before receiving a node announcement.
15232 void NodeInfo_set_announcement_info(struct LDKNodeInfo *NONNULL_PTR this_ptr, struct LDKNodeAnnouncementInfo val);
15235 * Constructs a new NodeInfo given each field
15237 MUST_USE_RES struct LDKNodeInfo NodeInfo_new(struct LDKCVec_u64Z channels_arg, struct LDKRoutingFees lowest_inbound_channel_fees_arg, struct LDKNodeAnnouncementInfo announcement_info_arg);
15240 * Creates a copy of the NodeInfo
15242 struct LDKNodeInfo NodeInfo_clone(const struct LDKNodeInfo *NONNULL_PTR orig);
15245 * Serialize the NodeInfo object into a byte array which can be read by NodeInfo_read
15247 struct LDKCVec_u8Z NodeInfo_write(const struct LDKNodeInfo *NONNULL_PTR obj);
15250 * Read a NodeInfo from a byte array, created by NodeInfo_write
15252 struct LDKCResult_NodeInfoDecodeErrorZ NodeInfo_read(struct LDKu8slice ser);
15255 * Serialize the NetworkGraph object into a byte array which can be read by NetworkGraph_read
15257 struct LDKCVec_u8Z NetworkGraph_write(const struct LDKNetworkGraph *NONNULL_PTR obj);
15260 * Read a NetworkGraph from a byte array, created by NetworkGraph_write
15262 struct LDKCResult_NetworkGraphDecodeErrorZ NetworkGraph_read(struct LDKu8slice ser);
15265 * Creates a new, empty, network graph.
15267 MUST_USE_RES struct LDKNetworkGraph NetworkGraph_new(struct LDKThirtyTwoBytes genesis_hash);
15270 * For an already known node (from channel announcements), update its stored properties from a
15271 * given node announcement.
15273 * You probably don't want to call this directly, instead relying on a NetGraphMsgHandler's
15274 * RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
15275 * routing messages from a source using a protocol other than the lightning P2P protocol.
15277 MUST_USE_RES struct LDKCResult_NoneLightningErrorZ NetworkGraph_update_node_from_announcement(struct LDKNetworkGraph *NONNULL_PTR this_arg, const struct LDKNodeAnnouncement *NONNULL_PTR msg);
15280 * For an already known node (from channel announcements), update its stored properties from a
15281 * given node announcement without verifying the associated signatures. Because we aren't
15282 * given the associated signatures here we cannot relay the node announcement to any of our
15285 MUST_USE_RES struct LDKCResult_NoneLightningErrorZ NetworkGraph_update_node_from_unsigned_announcement(struct LDKNetworkGraph *NONNULL_PTR this_arg, const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR msg);
15288 * Store or update channel info from a channel announcement.
15290 * You probably don't want to call this directly, instead relying on a NetGraphMsgHandler's
15291 * RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
15292 * routing messages from a source using a protocol other than the lightning P2P protocol.
15294 * If a `chain::Access` object is provided via `chain_access`, it will be called to verify
15295 * the corresponding UTXO exists on chain and is correctly-formatted.
15297 MUST_USE_RES struct LDKCResult_NoneLightningErrorZ NetworkGraph_update_channel_from_announcement(struct LDKNetworkGraph *NONNULL_PTR this_arg, const struct LDKChannelAnnouncement *NONNULL_PTR msg, struct LDKAccess *chain_access);
15300 * Store or update channel info from a channel announcement without verifying the associated
15301 * signatures. Because we aren't given the associated signatures here we cannot relay the
15302 * channel announcement to any of our peers.
15304 * If a `chain::Access` object is provided via `chain_access`, it will be called to verify
15305 * the corresponding UTXO exists on chain and is correctly-formatted.
15307 MUST_USE_RES struct LDKCResult_NoneLightningErrorZ NetworkGraph_update_channel_from_unsigned_announcement(struct LDKNetworkGraph *NONNULL_PTR this_arg, const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR msg, struct LDKAccess *chain_access);
15310 * Close a channel if a corresponding HTLC fail was sent.
15311 * If permanent, removes a channel from the local storage.
15312 * May cause the removal of nodes too, if this was their last channel.
15313 * If not permanent, makes channels unavailable for routing.
15315 void NetworkGraph_close_channel_from_update(struct LDKNetworkGraph *NONNULL_PTR this_arg, uint64_t short_channel_id, bool is_permanent);
15318 * For an already known (from announcement) channel, update info about one of the directions
15321 * You probably don't want to call this directly, instead relying on a NetGraphMsgHandler's
15322 * RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
15323 * routing messages from a source using a protocol other than the lightning P2P protocol.
15325 MUST_USE_RES struct LDKCResult_NoneLightningErrorZ NetworkGraph_update_channel(struct LDKNetworkGraph *NONNULL_PTR this_arg, const struct LDKChannelUpdate *NONNULL_PTR msg);
15328 * For an already known (from announcement) channel, update info about one of the directions
15329 * of the channel without verifying the associated signatures. Because we aren't given the
15330 * associated signatures here we cannot relay the channel update to any of our peers.
15332 MUST_USE_RES struct LDKCResult_NoneLightningErrorZ NetworkGraph_update_channel_unsigned(struct LDKNetworkGraph *NONNULL_PTR this_arg, const struct LDKUnsignedChannelUpdate *NONNULL_PTR msg);
15334 /* Text to put at the end of the generated file */