X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning-c-bindings%2Finclude%2Flightning.h;h=60ba6f714d10b7c967d16a2636296bd03b75c6e3;hb=143087ac211ffc225d993cec7033422c42d7f4d3;hp=eb6f45b713c3d9bd4fbe60f69cd1c0744f634000;hpb=1495575b517c90da925698da14f627bf0d5b313f;p=ldk-c-bindings diff --git a/lightning-c-bindings/include/lightning.h b/lightning-c-bindings/include/lightning.h index eb6f45b..60ba6f7 100644 --- a/lightning-c-bindings/include/lightning.h +++ b/lightning-c-bindings/include/lightning.h @@ -11,8 +11,6 @@ /** * An error when accessing the chain via [`Access`]. - * - * [`Access`]: trait.Access.html */ typedef enum LDKAccessError { /** @@ -156,10 +154,25 @@ typedef enum LDKLevel { LDKLevel_Sentinel, } LDKLevel; +/** + * An enum representing the possible Bitcoin or test networks which we can run on + */ typedef enum LDKNetwork { + /** + * The main Bitcoin blockchain. + */ LDKNetwork_Bitcoin, + /** + * The testnet3 blockchain. + */ LDKNetwork_Testnet, + /** + * A local test blockchain. + */ LDKNetwork_Regtest, + /** + * A blockchain on which blocks are signed instead of mined. + */ LDKNetwork_Signet, /** * Must be last for serialization purposes @@ -167,15 +180,45 @@ typedef enum LDKNetwork { LDKNetwork_Sentinel, } LDKNetwork; +/** + * Represents an error returned from libsecp256k1 during validation of some secp256k1 data + */ typedef enum LDKSecp256k1Error { + /** + * Signature failed verification + */ LDKSecp256k1Error_IncorrectSignature, + /** + * Badly sized message ("messages" are actually fixed-sized digests; see the MESSAGE_SIZE constant) + */ LDKSecp256k1Error_InvalidMessage, + /** + * Bad public key + */ LDKSecp256k1Error_InvalidPublicKey, + /** + * Bad signature + */ LDKSecp256k1Error_InvalidSignature, + /** + * Bad secret key + */ LDKSecp256k1Error_InvalidSecretKey, + /** + * Bad recovery id + */ LDKSecp256k1Error_InvalidRecoveryId, + /** + * Invalid tweak for add_assign or mul_assign + */ LDKSecp256k1Error_InvalidTweak, + /** + * tweak_add_check failed on an xonly public key + */ LDKSecp256k1Error_TweakCheckFailed, + /** + * Didn't pass enough memory to context creation with preallocated memory + */ LDKSecp256k1Error_NotEnoughMemory, /** * Must be last for serialization purposes @@ -200,15 +243,34 @@ typedef enum LDKSecp256k1Error { */ typedef struct LDKTransaction { /** + * The serialized transaction data. + * * This is non-const for your convenience, an object passed to Rust is never written to. */ uint8_t *data; + /** + * The length of the serialized transaction + */ uintptr_t datalen; + /** + * Whether the data pointed to by `data` should be freed or not. + */ bool data_is_owned; } LDKTransaction; +/** + * A dynamically-allocated array of u8s of arbitrary size. + * This corresponds to std::vector in C++ + */ typedef struct LDKCVec_u8Z { + /** + * The elements in the array. + * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc(). + */ uint8_t *data; + /** + * The number of elements pointed to by `data`. + */ uintptr_t datalen; } LDKCVec_u8Z; @@ -217,35 +279,99 @@ typedef struct LDKCVec_u8Z { * This type *does* own its own memory, so must be free'd appropriately. */ typedef struct LDKTxOut { + /** + * The script_pubkey in this output + */ struct LDKCVec_u8Z script_pubkey; + /** + * The value, in satoshis, of this output + */ uint64_t value; } LDKTxOut; +/** + * Represents a valid secp256k1 secret key serialized as a 32 byte array. + */ typedef struct LDKSecretKey { + /** + * The bytes of the secret key + */ uint8_t bytes[32]; } LDKSecretKey; +/** + * The contents of CResult_SecretKeyErrorZ + */ typedef union LDKCResult_SecretKeyErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKSecretKey *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ enum LDKSecp256k1Error *err; } LDKCResult_SecretKeyErrorZPtr; +/** + * A CResult_SecretKeyErrorZ represents the result of a fallible operation, + * containing a crate::c_types::SecretKey on success and a crate::c_types::Secp256k1Error on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_SecretKeyErrorZ { + /** + * The contents of this CResult_SecretKeyErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_SecretKeyErrorZPtr contents; + /** + * Whether this CResult_SecretKeyErrorZ represents a success state. + */ bool result_ok; } LDKCResult_SecretKeyErrorZ; +/** + * Represents a valid secp256k1 public key serialized in "compressed form" as a 33 byte array. + */ typedef struct LDKPublicKey { + /** + * The bytes of the public key + */ uint8_t compressed_form[33]; } LDKPublicKey; +/** + * The contents of CResult_PublicKeyErrorZ + */ typedef union LDKCResult_PublicKeyErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKPublicKey *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ enum LDKSecp256k1Error *err; } LDKCResult_PublicKeyErrorZPtr; +/** + * A CResult_PublicKeyErrorZ represents the result of a fallible operation, + * containing a crate::c_types::PublicKey on success and a crate::c_types::Secp256k1Error on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_PublicKeyErrorZ { + /** + * The contents of this CResult_PublicKeyErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_PublicKeyErrorZPtr contents; + /** + * Whether this CResult_PublicKeyErrorZ represents a success state. + */ bool result_ok; } LDKCResult_PublicKeyErrorZ; @@ -266,10 +392,16 @@ typedef struct LDKCResult_PublicKeyErrorZ { */ typedef struct MUST_USE_STRUCT LDKTxCreationKeys { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeTxCreationKeys *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKTxCreationKeys; @@ -280,20 +412,49 @@ typedef struct MUST_USE_STRUCT LDKTxCreationKeys { */ typedef struct MUST_USE_STRUCT LDKDecodeError { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeDecodeError *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKDecodeError; +/** + * The contents of CResult_TxCreationKeysDecodeErrorZ + */ typedef union LDKCResult_TxCreationKeysDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKTxCreationKeys *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_TxCreationKeysDecodeErrorZPtr; +/** + * A CResult_TxCreationKeysDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::chan_utils::TxCreationKeys on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_TxCreationKeysDecodeErrorZ { + /** + * The contents of this CResult_TxCreationKeysDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_TxCreationKeysDecodeErrorZPtr contents; + /** + * Whether this CResult_TxCreationKeysDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_TxCreationKeysDecodeErrorZ; @@ -304,33 +465,112 @@ typedef struct LDKCResult_TxCreationKeysDecodeErrorZ { */ typedef struct MUST_USE_STRUCT LDKChannelPublicKeys { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeChannelPublicKeys *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKChannelPublicKeys; +/** + * The contents of CResult_ChannelPublicKeysDecodeErrorZ + */ typedef union LDKCResult_ChannelPublicKeysDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKChannelPublicKeys *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_ChannelPublicKeysDecodeErrorZPtr; +/** + * A CResult_ChannelPublicKeysDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::chan_utils::ChannelPublicKeys on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_ChannelPublicKeysDecodeErrorZ { + /** + * The contents of this CResult_ChannelPublicKeysDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_ChannelPublicKeysDecodeErrorZPtr contents; + /** + * Whether this CResult_ChannelPublicKeysDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_ChannelPublicKeysDecodeErrorZ; +/** + * The contents of CResult_TxCreationKeysErrorZ + */ typedef union LDKCResult_TxCreationKeysErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKTxCreationKeys *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ enum LDKSecp256k1Error *err; } LDKCResult_TxCreationKeysErrorZPtr; +/** + * A CResult_TxCreationKeysErrorZ represents the result of a fallible operation, + * containing a crate::ln::chan_utils::TxCreationKeys on success and a crate::c_types::Secp256k1Error on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_TxCreationKeysErrorZ { + /** + * The contents of this CResult_TxCreationKeysErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_TxCreationKeysErrorZPtr contents; + /** + * Whether this CResult_TxCreationKeysErrorZ represents a success state. + */ bool result_ok; } LDKCResult_TxCreationKeysErrorZ; +/** + * An enum which can either contain a u32 or not + */ +typedef enum LDKCOption_u32Z_Tag { + /** + * When we're in this state, this COption_u32Z contains a u32 + */ + LDKCOption_u32Z_Some, + /** + * When we're in this state, this COption_u32Z contains nothing + */ + LDKCOption_u32Z_None, + /** + * Must be last for serialization purposes + */ + LDKCOption_u32Z_Sentinel, +} LDKCOption_u32Z_Tag; + +typedef struct LDKCOption_u32Z { + LDKCOption_u32Z_Tag tag; + union { + struct { + uint32_t some; + }; + }; +} LDKCOption_u32Z; + /** @@ -338,20 +578,49 @@ typedef struct LDKCResult_TxCreationKeysErrorZ { */ typedef struct MUST_USE_STRUCT LDKHTLCOutputInCommitment { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeHTLCOutputInCommitment *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKHTLCOutputInCommitment; +/** + * The contents of CResult_HTLCOutputInCommitmentDecodeErrorZ + */ typedef union LDKCResult_HTLCOutputInCommitmentDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKHTLCOutputInCommitment *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_HTLCOutputInCommitmentDecodeErrorZPtr; +/** + * A CResult_HTLCOutputInCommitmentDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::chan_utils::HTLCOutputInCommitment on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ { + /** + * The contents of this CResult_HTLCOutputInCommitmentDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_HTLCOutputInCommitmentDecodeErrorZPtr contents; + /** + * Whether this CResult_HTLCOutputInCommitmentDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_HTLCOutputInCommitmentDecodeErrorZ; @@ -362,20 +631,49 @@ typedef struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ { */ typedef struct MUST_USE_STRUCT LDKCounterpartyChannelTransactionParameters { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeCounterpartyChannelTransactionParameters *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKCounterpartyChannelTransactionParameters; +/** + * The contents of CResult_CounterpartyChannelTransactionParametersDecodeErrorZ + */ typedef union LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKCounterpartyChannelTransactionParameters *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZPtr; +/** + * A CResult_CounterpartyChannelTransactionParametersDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::chan_utils::CounterpartyChannelTransactionParameters on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ { + /** + * The contents of this CResult_CounterpartyChannelTransactionParametersDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZPtr contents; + /** + * Whether this CResult_CounterpartyChannelTransactionParametersDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ; @@ -390,29 +688,75 @@ typedef struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ { */ typedef struct MUST_USE_STRUCT LDKChannelTransactionParameters { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeChannelTransactionParameters *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKChannelTransactionParameters; +/** + * The contents of CResult_ChannelTransactionParametersDecodeErrorZ + */ typedef union LDKCResult_ChannelTransactionParametersDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKChannelTransactionParameters *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_ChannelTransactionParametersDecodeErrorZPtr; +/** + * A CResult_ChannelTransactionParametersDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::chan_utils::ChannelTransactionParameters on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_ChannelTransactionParametersDecodeErrorZ { + /** + * The contents of this CResult_ChannelTransactionParametersDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_ChannelTransactionParametersDecodeErrorZPtr contents; + /** + * Whether this CResult_ChannelTransactionParametersDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_ChannelTransactionParametersDecodeErrorZ; +/** + * Represents a secp256k1 signature serialized as two 32-byte numbers + */ typedef struct LDKSignature { + /** + * The bytes of the signature in "compact" form + */ uint8_t compact_form[64]; } LDKSignature; +/** + * A dynamically-allocated array of crate::c_types::Signatures of arbitrary size. + * This corresponds to std::vector in C++ + */ typedef struct LDKCVec_SignatureZ { + /** + * The elements in the array. + * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc(). + */ struct LDKSignature *data; + /** + * The number of elements pointed to by `data`. + */ uintptr_t datalen; } LDKCVec_SignatureZ; @@ -425,20 +769,49 @@ typedef struct LDKCVec_SignatureZ { */ typedef struct MUST_USE_STRUCT LDKHolderCommitmentTransaction { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeHolderCommitmentTransaction *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKHolderCommitmentTransaction; +/** + * The contents of CResult_HolderCommitmentTransactionDecodeErrorZ + */ typedef union LDKCResult_HolderCommitmentTransactionDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKHolderCommitmentTransaction *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_HolderCommitmentTransactionDecodeErrorZPtr; +/** + * A CResult_HolderCommitmentTransactionDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::chan_utils::HolderCommitmentTransaction on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ { + /** + * The contents of this CResult_HolderCommitmentTransactionDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_HolderCommitmentTransactionDecodeErrorZPtr contents; + /** + * Whether this CResult_HolderCommitmentTransactionDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_HolderCommitmentTransactionDecodeErrorZ; @@ -449,20 +822,49 @@ typedef struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ { */ typedef struct MUST_USE_STRUCT LDKBuiltCommitmentTransaction { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeBuiltCommitmentTransaction *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKBuiltCommitmentTransaction; +/** + * The contents of CResult_BuiltCommitmentTransactionDecodeErrorZ + */ typedef union LDKCResult_BuiltCommitmentTransactionDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKBuiltCommitmentTransaction *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_BuiltCommitmentTransactionDecodeErrorZPtr; +/** + * A CResult_BuiltCommitmentTransactionDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::chan_utils::BuiltCommitmentTransaction on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ { + /** + * The contents of this CResult_BuiltCommitmentTransactionDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_BuiltCommitmentTransactionDecodeErrorZPtr contents; + /** + * Whether this CResult_BuiltCommitmentTransactionDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_BuiltCommitmentTransactionDecodeErrorZ; @@ -478,20 +880,49 @@ typedef struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ { */ typedef struct MUST_USE_STRUCT LDKCommitmentTransaction { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeCommitmentTransaction *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKCommitmentTransaction; +/** + * The contents of CResult_CommitmentTransactionDecodeErrorZ + */ typedef union LDKCResult_CommitmentTransactionDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKCommitmentTransaction *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_CommitmentTransactionDecodeErrorZPtr; +/** + * A CResult_CommitmentTransactionDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::chan_utils::CommitmentTransaction on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_CommitmentTransactionDecodeErrorZ { + /** + * The contents of this CResult_CommitmentTransactionDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_CommitmentTransactionDecodeErrorZPtr contents; + /** + * Whether this CResult_CommitmentTransactionDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_CommitmentTransactionDecodeErrorZ; @@ -507,14 +938,27 @@ typedef struct LDKCResult_CommitmentTransactionDecodeErrorZ { */ typedef struct MUST_USE_STRUCT LDKTrustedCommitmentTransaction { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeTrustedCommitmentTransaction *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKTrustedCommitmentTransaction; +/** + * The contents of CResult_TrustedCommitmentTransactionNoneZ + */ typedef union LDKCResult_TrustedCommitmentTransactionNoneZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKTrustedCommitmentTransaction *result; /** * Note that this value is always NULL, as there are no contents in the Err variant @@ -522,12 +966,31 @@ typedef union LDKCResult_TrustedCommitmentTransactionNoneZPtr { void *err; } LDKCResult_TrustedCommitmentTransactionNoneZPtr; +/** + * A CResult_TrustedCommitmentTransactionNoneZ represents the result of a fallible operation, + * containing a crate::ln::chan_utils::TrustedCommitmentTransaction on success and a () on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_TrustedCommitmentTransactionNoneZ { + /** + * The contents of this CResult_TrustedCommitmentTransactionNoneZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_TrustedCommitmentTransactionNoneZPtr contents; + /** + * Whether this CResult_TrustedCommitmentTransactionNoneZ represents a success state. + */ bool result_ok; } LDKCResult_TrustedCommitmentTransactionNoneZ; +/** + * The contents of CResult_CVec_SignatureZNoneZ + */ typedef union LDKCResult_CVec_SignatureZNoneZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKCVec_SignatureZ *result; /** * Note that this value is always NULL, as there are no contents in the Err variant @@ -535,8 +998,20 @@ typedef union LDKCResult_CVec_SignatureZNoneZPtr { void *err; } LDKCResult_CVec_SignatureZNoneZPtr; +/** + * A CResult_CVec_SignatureZNoneZ represents the result of a fallible operation, + * containing a crate::c_types::derived::CVec_SignatureZ on success and a () on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_CVec_SignatureZNoneZ { + /** + * The contents of this CResult_CVec_SignatureZNoneZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_CVec_SignatureZNoneZPtr contents; + /** + * Whether this CResult_CVec_SignatureZNoneZ represents a success state. + */ bool result_ok; } LDKCResult_CVec_SignatureZNoneZ; @@ -547,10 +1022,16 @@ typedef struct LDKCResult_CVec_SignatureZNoneZ { */ typedef struct MUST_USE_STRUCT LDKAcceptChannel { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeAcceptChannel *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKAcceptChannel; @@ -561,10 +1042,16 @@ typedef struct MUST_USE_STRUCT LDKAcceptChannel { */ typedef struct MUST_USE_STRUCT LDKOpenChannel { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeOpenChannel *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKOpenChannel; @@ -575,11 +1062,17 @@ typedef struct MUST_USE_STRUCT LDKOpenChannel { */ typedef struct MUST_USE_STRUCT LDKFundingCreated { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeFundingCreated *inner; - bool is_owned; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ + bool is_owned; } LDKFundingCreated; @@ -589,10 +1082,16 @@ typedef struct MUST_USE_STRUCT LDKFundingCreated { */ typedef struct MUST_USE_STRUCT LDKFundingSigned { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeFundingSigned *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKFundingSigned; @@ -603,10 +1102,16 @@ typedef struct MUST_USE_STRUCT LDKFundingSigned { */ typedef struct MUST_USE_STRUCT LDKFundingLocked { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeFundingLocked *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKFundingLocked; @@ -617,10 +1122,16 @@ typedef struct MUST_USE_STRUCT LDKFundingLocked { */ typedef struct MUST_USE_STRUCT LDKAnnouncementSignatures { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeAnnouncementSignatures *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKAnnouncementSignatures; @@ -632,10 +1143,16 @@ typedef struct MUST_USE_STRUCT LDKAnnouncementSignatures { */ typedef struct MUST_USE_STRUCT LDKCommitmentUpdate { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeCommitmentUpdate *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKCommitmentUpdate; @@ -646,10 +1163,16 @@ typedef struct MUST_USE_STRUCT LDKCommitmentUpdate { */ typedef struct MUST_USE_STRUCT LDKRevokeAndACK { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeRevokeAndACK *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKRevokeAndACK; @@ -660,10 +1183,16 @@ typedef struct MUST_USE_STRUCT LDKRevokeAndACK { */ typedef struct MUST_USE_STRUCT LDKClosingSigned { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeClosingSigned *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKClosingSigned; @@ -674,10 +1203,16 @@ typedef struct MUST_USE_STRUCT LDKClosingSigned { */ typedef struct MUST_USE_STRUCT LDKShutdown { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeShutdown *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKShutdown; @@ -688,10 +1223,16 @@ typedef struct MUST_USE_STRUCT LDKShutdown { */ typedef struct MUST_USE_STRUCT LDKChannelReestablish { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeChannelReestablish *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKChannelReestablish; @@ -702,10 +1243,16 @@ typedef struct MUST_USE_STRUCT LDKChannelReestablish { */ typedef struct MUST_USE_STRUCT LDKChannelAnnouncement { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeChannelAnnouncement *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKChannelAnnouncement; @@ -716,10 +1263,16 @@ typedef struct MUST_USE_STRUCT LDKChannelAnnouncement { */ typedef struct MUST_USE_STRUCT LDKChannelUpdate { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeChannelUpdate *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKChannelUpdate; @@ -730,10 +1283,16 @@ typedef struct MUST_USE_STRUCT LDKChannelUpdate { */ typedef struct MUST_USE_STRUCT LDKNodeAnnouncement { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeNodeAnnouncement *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKNodeAnnouncement; @@ -744,10 +1303,16 @@ typedef struct MUST_USE_STRUCT LDKNodeAnnouncement { */ typedef struct MUST_USE_STRUCT LDKErrorMessage { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeErrorMessage *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKErrorMessage; @@ -774,10 +1339,16 @@ typedef enum LDKErrorAction_Tag { } LDKErrorAction_Tag; typedef struct LDKErrorAction_LDKDisconnectPeer_Body { + /** + * An error message which we should make an effort to send before we disconnect. + */ struct LDKErrorMessage msg; } LDKErrorAction_LDKDisconnectPeer_Body; typedef struct LDKErrorAction_LDKSendErrorMessage_Body { + /** + * The message to send. + */ struct LDKErrorMessage msg; } LDKErrorAction_LDKSendErrorMessage_Body; @@ -814,16 +1385,34 @@ typedef enum LDKHTLCFailChannelUpdate_Tag { } LDKHTLCFailChannelUpdate_Tag; typedef struct LDKHTLCFailChannelUpdate_LDKChannelUpdateMessage_Body { + /** + * The unwrapped message we received + */ struct LDKChannelUpdate msg; } LDKHTLCFailChannelUpdate_LDKChannelUpdateMessage_Body; typedef struct LDKHTLCFailChannelUpdate_LDKChannelClosed_Body { + /** + * The short_channel_id which has now closed. + */ uint64_t short_channel_id; + /** + * when this true, this channel should be permanently removed from the + * consideration. Otherwise, this channel can be restored as new channel_update is received + */ bool is_permanent; } LDKHTLCFailChannelUpdate_LDKChannelClosed_Body; typedef struct LDKHTLCFailChannelUpdate_LDKNodeFailure_Body { + /** + * The node_id that has failed. + */ struct LDKPublicKey node_id; + /** + * when this true, node should be permanently removed from the + * consideration. Otherwise, the channels connected to this node can be + * restored as new channel_update is received + */ bool is_permanent; } LDKHTLCFailChannelUpdate_LDKNodeFailure_Body; @@ -846,10 +1435,16 @@ typedef struct MUST_USE_STRUCT LDKHTLCFailChannelUpdate { */ typedef struct MUST_USE_STRUCT LDKQueryChannelRange { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeQueryChannelRange *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKQueryChannelRange; @@ -867,13 +1462,45 @@ typedef struct MUST_USE_STRUCT LDKQueryChannelRange { */ typedef struct MUST_USE_STRUCT LDKQueryShortChannelIds { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeQueryShortChannelIds *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKQueryShortChannelIds; + + +/** + * A reply_channel_range message is a reply to a query_channel_range + * message. Multiple reply_channel_range messages can be sent in reply + * to a single query_channel_range message. The query recipient makes a + * best effort to respond based on their local network view which may + * not be a perfect view of the network. The short_channel_ids in the + * reply are encoded. We only support encoding_type=0 uncompressed + * serialization and do not support encoding_type=1 zlib serialization. + */ +typedef struct MUST_USE_STRUCT LDKReplyChannelRange { + /** + * A pointer to the opaque Rust object. + * Nearly everywhere, inner must be non-null, however in places where + * the Rust equivalent takes an Option, it may be set to null to indicate None. + */ + LDKnativeReplyChannelRange *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ + bool is_owned; +} LDKReplyChannelRange; + /** * An event generated by ChannelManager which indicates a message should be sent to a peer (or * broadcast to most peers). @@ -964,6 +1591,11 @@ typedef enum LDKMessageSendEvent_Tag { * their short_channel_ids. */ LDKMessageSendEvent_SendShortIdsQuery, + /** + * Sends a reply to a channel range query. This may be one of several SendReplyChannelRange events + * emitted during processing of the query. + */ + LDKMessageSendEvent_SendReplyChannelRange, /** * Must be last for serialization purposes */ @@ -971,92 +1603,202 @@ typedef enum LDKMessageSendEvent_Tag { } LDKMessageSendEvent_Tag; typedef struct LDKMessageSendEvent_LDKSendAcceptChannel_Body { + /** + * The node_id of the node which should receive this message + */ struct LDKPublicKey node_id; + /** + * The message which should be sent. + */ struct LDKAcceptChannel msg; } LDKMessageSendEvent_LDKSendAcceptChannel_Body; typedef struct LDKMessageSendEvent_LDKSendOpenChannel_Body { + /** + * The node_id of the node which should receive this message + */ struct LDKPublicKey node_id; + /** + * The message which should be sent. + */ struct LDKOpenChannel msg; } LDKMessageSendEvent_LDKSendOpenChannel_Body; typedef struct LDKMessageSendEvent_LDKSendFundingCreated_Body { + /** + * The node_id of the node which should receive this message + */ struct LDKPublicKey node_id; + /** + * The message which should be sent. + */ struct LDKFundingCreated msg; } LDKMessageSendEvent_LDKSendFundingCreated_Body; typedef struct LDKMessageSendEvent_LDKSendFundingSigned_Body { + /** + * The node_id of the node which should receive this message + */ struct LDKPublicKey node_id; + /** + * The message which should be sent. + */ struct LDKFundingSigned msg; } LDKMessageSendEvent_LDKSendFundingSigned_Body; typedef struct LDKMessageSendEvent_LDKSendFundingLocked_Body { + /** + * The node_id of the node which should receive these message(s) + */ struct LDKPublicKey node_id; + /** + * The funding_locked message which should be sent. + */ struct LDKFundingLocked msg; } LDKMessageSendEvent_LDKSendFundingLocked_Body; typedef struct LDKMessageSendEvent_LDKSendAnnouncementSignatures_Body { + /** + * The node_id of the node which should receive these message(s) + */ struct LDKPublicKey node_id; + /** + * The announcement_signatures message which should be sent. + */ struct LDKAnnouncementSignatures msg; } LDKMessageSendEvent_LDKSendAnnouncementSignatures_Body; typedef struct LDKMessageSendEvent_LDKUpdateHTLCs_Body { + /** + * The node_id of the node which should receive these message(s) + */ struct LDKPublicKey node_id; + /** + * The update messages which should be sent. ALL messages in the struct should be sent! + */ struct LDKCommitmentUpdate updates; } LDKMessageSendEvent_LDKUpdateHTLCs_Body; typedef struct LDKMessageSendEvent_LDKSendRevokeAndACK_Body { + /** + * The node_id of the node which should receive this message + */ struct LDKPublicKey node_id; + /** + * The message which should be sent. + */ struct LDKRevokeAndACK msg; } LDKMessageSendEvent_LDKSendRevokeAndACK_Body; typedef struct LDKMessageSendEvent_LDKSendClosingSigned_Body { + /** + * The node_id of the node which should receive this message + */ struct LDKPublicKey node_id; + /** + * The message which should be sent. + */ struct LDKClosingSigned msg; } LDKMessageSendEvent_LDKSendClosingSigned_Body; typedef struct LDKMessageSendEvent_LDKSendShutdown_Body { + /** + * The node_id of the node which should receive this message + */ struct LDKPublicKey node_id; + /** + * The message which should be sent. + */ struct LDKShutdown msg; } LDKMessageSendEvent_LDKSendShutdown_Body; typedef struct LDKMessageSendEvent_LDKSendChannelReestablish_Body { + /** + * The node_id of the node which should receive this message + */ struct LDKPublicKey node_id; + /** + * The message which should be sent. + */ struct LDKChannelReestablish msg; } LDKMessageSendEvent_LDKSendChannelReestablish_Body; typedef struct LDKMessageSendEvent_LDKBroadcastChannelAnnouncement_Body { + /** + * The channel_announcement which should be sent. + */ struct LDKChannelAnnouncement msg; + /** + * The followup channel_update which should be sent. + */ struct LDKChannelUpdate update_msg; } LDKMessageSendEvent_LDKBroadcastChannelAnnouncement_Body; typedef struct LDKMessageSendEvent_LDKBroadcastNodeAnnouncement_Body { + /** + * The node_announcement which should be sent. + */ struct LDKNodeAnnouncement msg; } LDKMessageSendEvent_LDKBroadcastNodeAnnouncement_Body; typedef struct LDKMessageSendEvent_LDKBroadcastChannelUpdate_Body { + /** + * The channel_update which should be sent. + */ struct LDKChannelUpdate msg; } LDKMessageSendEvent_LDKBroadcastChannelUpdate_Body; typedef struct LDKMessageSendEvent_LDKHandleError_Body { + /** + * The node_id of the node which should receive this message + */ struct LDKPublicKey node_id; + /** + * The action which should be taken. + */ struct LDKErrorAction action; } LDKMessageSendEvent_LDKHandleError_Body; typedef struct LDKMessageSendEvent_LDKPaymentFailureNetworkUpdate_Body { + /** + * The channel/node update which should be sent to NetGraphMsgHandler + */ struct LDKHTLCFailChannelUpdate update; } LDKMessageSendEvent_LDKPaymentFailureNetworkUpdate_Body; typedef struct LDKMessageSendEvent_LDKSendChannelRangeQuery_Body { + /** + * The node_id of this message recipient + */ struct LDKPublicKey node_id; + /** + * The query_channel_range which should be sent. + */ struct LDKQueryChannelRange msg; } LDKMessageSendEvent_LDKSendChannelRangeQuery_Body; typedef struct LDKMessageSendEvent_LDKSendShortIdsQuery_Body { + /** + * The node_id of this message recipient + */ struct LDKPublicKey node_id; + /** + * The query_short_channel_ids which should be sent. + */ struct LDKQueryShortChannelIds msg; } LDKMessageSendEvent_LDKSendShortIdsQuery_Body; +typedef struct LDKMessageSendEvent_LDKSendReplyChannelRange_Body { + /** + * The node_id of this message recipient + */ + struct LDKPublicKey node_id; + /** + * The reply_channel_range which should be sent. + */ + struct LDKReplyChannelRange msg; +} LDKMessageSendEvent_LDKSendReplyChannelRange_Body; + typedef struct MUST_USE_STRUCT LDKMessageSendEvent { LDKMessageSendEvent_Tag tag; union { @@ -1078,11 +1820,23 @@ typedef struct MUST_USE_STRUCT LDKMessageSendEvent { LDKMessageSendEvent_LDKPaymentFailureNetworkUpdate_Body payment_failure_network_update; LDKMessageSendEvent_LDKSendChannelRangeQuery_Body send_channel_range_query; LDKMessageSendEvent_LDKSendShortIdsQuery_Body send_short_ids_query; + LDKMessageSendEvent_LDKSendReplyChannelRange_Body send_reply_channel_range; }; } LDKMessageSendEvent; +/** + * A dynamically-allocated array of crate::util::events::MessageSendEvents of arbitrary size. + * This corresponds to std::vector in C++ + */ typedef struct LDKCVec_MessageSendEventZ { + /** + * The elements in the array. + * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc(). + */ struct LDKMessageSendEvent *data; + /** + * The number of elements pointed to by `data`. + */ uintptr_t datalen; } LDKCVec_MessageSendEventZ; @@ -1093,54 +1847,147 @@ typedef struct LDKCVec_MessageSendEventZ { */ typedef struct MUST_USE_STRUCT LDKLightningError { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeLightningError *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKLightningError; +/** + * The contents of CResult_boolLightningErrorZ + */ typedef union LDKCResult_boolLightningErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ bool *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKLightningError *err; } LDKCResult_boolLightningErrorZPtr; +/** + * A CResult_boolLightningErrorZ represents the result of a fallible operation, + * containing a bool on success and a crate::ln::msgs::LightningError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_boolLightningErrorZ { + /** + * The contents of this CResult_boolLightningErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_boolLightningErrorZPtr contents; + /** + * Whether this CResult_boolLightningErrorZ represents a success state. + */ bool result_ok; } LDKCResult_boolLightningErrorZ; +/** + * A tuple of 3 elements. See the individual fields for the types contained. + */ typedef struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ { + /** + * The element at position 0 + */ struct LDKChannelAnnouncement a; + /** + * The element at position 1 + */ struct LDKChannelUpdate b; + /** + * The element at position 2 + */ struct LDKChannelUpdate c; } LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ; +/** + * A dynamically-allocated array of crate::c_types::derived::C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZs of arbitrary size. + * This corresponds to std::vector in C++ + */ typedef struct LDKCVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ { + /** + * The elements in the array. + * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc(). + */ struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ *data; + /** + * The number of elements pointed to by `data`. + */ uintptr_t datalen; } LDKCVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ; +/** + * A dynamically-allocated array of crate::ln::msgs::NodeAnnouncements of arbitrary size. + * This corresponds to std::vector in C++ + */ typedef struct LDKCVec_NodeAnnouncementZ { + /** + * The elements in the array. + * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc(). + */ struct LDKNodeAnnouncement *data; + /** + * The number of elements pointed to by `data`. + */ uintptr_t datalen; } LDKCVec_NodeAnnouncementZ; +/** + * The contents of CResult_NoneLightningErrorZ + */ typedef union LDKCResult_NoneLightningErrorZPtr { /** * Note that this value is always NULL, as there are no contents in the OK variant */ void *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKLightningError *err; } LDKCResult_NoneLightningErrorZPtr; +/** + * A CResult_NoneLightningErrorZ represents the result of a fallible operation, + * containing a () on success and a crate::ln::msgs::LightningError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_NoneLightningErrorZ { + /** + * The contents of this CResult_NoneLightningErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_NoneLightningErrorZPtr contents; + /** + * Whether this CResult_NoneLightningErrorZ represents a success state. + */ bool result_ok; } LDKCResult_NoneLightningErrorZ; +/** + * A dynamically-allocated array of crate::c_types::PublicKeys of arbitrary size. + * This corresponds to std::vector in C++ + */ typedef struct LDKCVec_PublicKeyZ { + /** + * The elements in the array. + * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc(). + */ struct LDKPublicKey *data; + /** + * The number of elements pointed to by `data`. + */ uintptr_t datalen; } LDKCVec_PublicKeyZ; @@ -1153,43 +2000,114 @@ typedef struct LDKCVec_PublicKeyZ { */ typedef struct MUST_USE_STRUCT LDKPeerHandleError { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativePeerHandleError *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKPeerHandleError; +/** + * The contents of CResult_CVec_u8ZPeerHandleErrorZ + */ typedef union LDKCResult_CVec_u8ZPeerHandleErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKCVec_u8Z *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKPeerHandleError *err; } LDKCResult_CVec_u8ZPeerHandleErrorZPtr; +/** + * A CResult_CVec_u8ZPeerHandleErrorZ represents the result of a fallible operation, + * containing a crate::c_types::derived::CVec_u8Z on success and a crate::ln::peer_handler::PeerHandleError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_CVec_u8ZPeerHandleErrorZ { + /** + * The contents of this CResult_CVec_u8ZPeerHandleErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_CVec_u8ZPeerHandleErrorZPtr contents; + /** + * Whether this CResult_CVec_u8ZPeerHandleErrorZ represents a success state. + */ bool result_ok; } LDKCResult_CVec_u8ZPeerHandleErrorZ; +/** + * The contents of CResult_NonePeerHandleErrorZ + */ typedef union LDKCResult_NonePeerHandleErrorZPtr { /** * Note that this value is always NULL, as there are no contents in the OK variant */ void *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKPeerHandleError *err; } LDKCResult_NonePeerHandleErrorZPtr; +/** + * A CResult_NonePeerHandleErrorZ represents the result of a fallible operation, + * containing a () on success and a crate::ln::peer_handler::PeerHandleError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_NonePeerHandleErrorZ { + /** + * The contents of this CResult_NonePeerHandleErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_NonePeerHandleErrorZPtr contents; + /** + * Whether this CResult_NonePeerHandleErrorZ represents a success state. + */ bool result_ok; } LDKCResult_NonePeerHandleErrorZ; +/** + * The contents of CResult_boolPeerHandleErrorZ + */ typedef union LDKCResult_boolPeerHandleErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ bool *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKPeerHandleError *err; } LDKCResult_boolPeerHandleErrorZPtr; +/** + * A CResult_boolPeerHandleErrorZ represents the result of a fallible operation, + * containing a bool on success and a crate::ln::peer_handler::PeerHandleError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_boolPeerHandleErrorZ { + /** + * The contents of this CResult_boolPeerHandleErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_boolPeerHandleErrorZPtr contents; + /** + * Whether this CResult_boolPeerHandleErrorZ represents a success state. + */ bool result_ok; } LDKCResult_boolPeerHandleErrorZ; @@ -1200,20 +2118,49 @@ typedef struct LDKCResult_boolPeerHandleErrorZ { */ typedef struct MUST_USE_STRUCT LDKInitFeatures { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeInitFeatures *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKInitFeatures; +/** + * The contents of CResult_InitFeaturesDecodeErrorZ + */ typedef union LDKCResult_InitFeaturesDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKInitFeatures *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_InitFeaturesDecodeErrorZPtr; +/** + * A CResult_InitFeaturesDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::features::InitFeatures on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_InitFeaturesDecodeErrorZ { + /** + * The contents of this CResult_InitFeaturesDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_InitFeaturesDecodeErrorZPtr contents; + /** + * Whether this CResult_InitFeaturesDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_InitFeaturesDecodeErrorZ; @@ -1224,20 +2171,49 @@ typedef struct LDKCResult_InitFeaturesDecodeErrorZ { */ typedef struct MUST_USE_STRUCT LDKNodeFeatures { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeNodeFeatures *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKNodeFeatures; +/** + * The contents of CResult_NodeFeaturesDecodeErrorZ + */ typedef union LDKCResult_NodeFeaturesDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKNodeFeatures *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_NodeFeaturesDecodeErrorZPtr; -typedef struct LDKCResult_NodeFeaturesDecodeErrorZ { +/** + * A CResult_NodeFeaturesDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::features::NodeFeatures on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ +typedef struct LDKCResult_NodeFeaturesDecodeErrorZ { + /** + * The contents of this CResult_NodeFeaturesDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_NodeFeaturesDecodeErrorZPtr contents; + /** + * Whether this CResult_NodeFeaturesDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_NodeFeaturesDecodeErrorZ; @@ -1248,48 +2224,186 @@ typedef struct LDKCResult_NodeFeaturesDecodeErrorZ { */ typedef struct MUST_USE_STRUCT LDKChannelFeatures { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeChannelFeatures *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKChannelFeatures; +/** + * The contents of CResult_ChannelFeaturesDecodeErrorZ + */ typedef union LDKCResult_ChannelFeaturesDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKChannelFeatures *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_ChannelFeaturesDecodeErrorZPtr; +/** + * A CResult_ChannelFeaturesDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::features::ChannelFeatures on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_ChannelFeaturesDecodeErrorZ { + /** + * The contents of this CResult_ChannelFeaturesDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_ChannelFeaturesDecodeErrorZPtr contents; + /** + * Whether this CResult_ChannelFeaturesDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_ChannelFeaturesDecodeErrorZ; +/** + * Features used within an invoice. + */ +typedef struct MUST_USE_STRUCT LDKInvoiceFeatures { + /** + * A pointer to the opaque Rust object. + * Nearly everywhere, inner must be non-null, however in places where + * the Rust equivalent takes an Option, it may be set to null to indicate None. + */ + LDKnativeInvoiceFeatures *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ + bool is_owned; +} LDKInvoiceFeatures; + +/** + * The contents of CResult_InvoiceFeaturesDecodeErrorZ + */ +typedef union LDKCResult_InvoiceFeaturesDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ + struct LDKInvoiceFeatures *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ + struct LDKDecodeError *err; +} LDKCResult_InvoiceFeaturesDecodeErrorZPtr; + +/** + * A CResult_InvoiceFeaturesDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::features::InvoiceFeatures on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ +typedef struct LDKCResult_InvoiceFeaturesDecodeErrorZ { + /** + * The contents of this CResult_InvoiceFeaturesDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ + union LDKCResult_InvoiceFeaturesDecodeErrorZPtr contents; + /** + * Whether this CResult_InvoiceFeaturesDecodeErrorZ represents a success state. + */ + bool result_ok; +} LDKCResult_InvoiceFeaturesDecodeErrorZ; + + + /** * Options which apply on a per-channel basis and may change at runtime or based on negotiation * with our counterparty. */ typedef struct MUST_USE_STRUCT LDKChannelConfig { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeChannelConfig *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKChannelConfig; +/** + * The contents of CResult_ChannelConfigDecodeErrorZ + */ typedef union LDKCResult_ChannelConfigDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKChannelConfig *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_ChannelConfigDecodeErrorZPtr; +/** + * A CResult_ChannelConfigDecodeErrorZ represents the result of a fallible operation, + * containing a crate::util::config::ChannelConfig on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_ChannelConfigDecodeErrorZ { + /** + * The contents of this CResult_ChannelConfigDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_ChannelConfigDecodeErrorZPtr contents; + /** + * Whether this CResult_ChannelConfigDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_ChannelConfigDecodeErrorZ; +/** + * An enum which can either contain a u64 or not + */ +typedef enum LDKCOption_u64Z_Tag { + /** + * When we're in this state, this COption_u64Z contains a u64 + */ + LDKCOption_u64Z_Some, + /** + * When we're in this state, this COption_u64Z contains nothing + */ + LDKCOption_u64Z_None, + /** + * Must be last for serialization purposes + */ + LDKCOption_u64Z_Sentinel, +} LDKCOption_u64Z_Tag; + +typedef struct LDKCOption_u64Z { + LDKCOption_u64Z_Tag tag; + union { + struct { + uint64_t some; + }; + }; +} LDKCOption_u64Z; + /** @@ -1298,20 +2412,49 @@ typedef struct LDKCResult_ChannelConfigDecodeErrorZ { */ typedef struct MUST_USE_STRUCT LDKDirectionalChannelInfo { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeDirectionalChannelInfo *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKDirectionalChannelInfo; +/** + * The contents of CResult_DirectionalChannelInfoDecodeErrorZ + */ typedef union LDKCResult_DirectionalChannelInfoDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKDirectionalChannelInfo *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_DirectionalChannelInfoDecodeErrorZPtr; +/** + * A CResult_DirectionalChannelInfoDecodeErrorZ represents the result of a fallible operation, + * containing a crate::routing::network_graph::DirectionalChannelInfo on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_DirectionalChannelInfoDecodeErrorZ { + /** + * The contents of this CResult_DirectionalChannelInfoDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_DirectionalChannelInfoDecodeErrorZPtr contents; + /** + * Whether this CResult_DirectionalChannelInfoDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_DirectionalChannelInfoDecodeErrorZ; @@ -1323,20 +2466,49 @@ typedef struct LDKCResult_DirectionalChannelInfoDecodeErrorZ { */ typedef struct MUST_USE_STRUCT LDKChannelInfo { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeChannelInfo *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKChannelInfo; +/** + * The contents of CResult_ChannelInfoDecodeErrorZ + */ typedef union LDKCResult_ChannelInfoDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKChannelInfo *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_ChannelInfoDecodeErrorZPtr; +/** + * A CResult_ChannelInfoDecodeErrorZ represents the result of a fallible operation, + * containing a crate::routing::network_graph::ChannelInfo on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_ChannelInfoDecodeErrorZ { + /** + * The contents of this CResult_ChannelInfoDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_ChannelInfoDecodeErrorZPtr contents; + /** + * Whether this CResult_ChannelInfoDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_ChannelInfoDecodeErrorZ; @@ -1347,32 +2519,79 @@ typedef struct LDKCResult_ChannelInfoDecodeErrorZ { */ typedef struct MUST_USE_STRUCT LDKRoutingFees { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeRoutingFees *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKRoutingFees; +/** + * The contents of CResult_RoutingFeesDecodeErrorZ + */ typedef union LDKCResult_RoutingFeesDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKRoutingFees *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_RoutingFeesDecodeErrorZPtr; +/** + * A CResult_RoutingFeesDecodeErrorZ represents the result of a fallible operation, + * containing a crate::routing::network_graph::RoutingFees on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_RoutingFeesDecodeErrorZ { + /** + * The contents of this CResult_RoutingFeesDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_RoutingFeesDecodeErrorZPtr contents; + /** + * Whether this CResult_RoutingFeesDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_RoutingFeesDecodeErrorZ; +/** + * A 4-byte byte array. + */ typedef struct LDKFourBytes { + /** + * The four bytes + */ uint8_t data[4]; } LDKFourBytes; +/** + * A 16-byte byte array. + */ typedef struct LDKSixteenBytes { + /** + * The sixteen bytes + */ uint8_t data[16]; } LDKSixteenBytes; +/** + * A 10-byte byte array. + */ typedef struct LDKTenBytes { + /** + * The ten bytes + */ uint8_t data[10]; } LDKTenBytes; @@ -1381,6 +2600,9 @@ typedef struct LDKTenBytes { * look up the corresponding function in rust-lightning's docs. */ typedef struct LDKThirtyTwoBytes { + /** + * The thirty-two bytes + */ uint8_t data[32]; } LDKThirtyTwoBytes; @@ -1413,24 +2635,54 @@ typedef enum LDKNetAddress_Tag { } LDKNetAddress_Tag; typedef struct LDKNetAddress_LDKIPv4_Body { + /** + * The 4-byte IPv4 address + */ struct LDKFourBytes addr; + /** + * The port on which the node is listening + */ uint16_t port; } LDKNetAddress_LDKIPv4_Body; typedef struct LDKNetAddress_LDKIPv6_Body { + /** + * The 16-byte IPv6 address + */ struct LDKSixteenBytes addr; + /** + * The port on which the node is listening + */ uint16_t port; } LDKNetAddress_LDKIPv6_Body; typedef struct LDKNetAddress_LDKOnionV2_Body { + /** + * The bytes (usually encoded in base32 with \".onion\" appended) + */ struct LDKTenBytes addr; + /** + * The port on which the node is listening + */ uint16_t port; } LDKNetAddress_LDKOnionV2_Body; typedef struct LDKNetAddress_LDKOnionV3_Body { + /** + * The ed25519 long-term public key of the peer + */ struct LDKThirtyTwoBytes ed25519_pubkey; + /** + * The checksum of the pubkey and version, as included in the onion address + */ uint16_t checksum; + /** + * The version byte, as defined by the Tor Onion v3 spec. + */ uint8_t version; + /** + * The port on which the node is listening + */ uint16_t port; } LDKNetAddress_LDKOnionV3_Body; @@ -1444,8 +2696,19 @@ typedef struct MUST_USE_STRUCT LDKNetAddress { }; } LDKNetAddress; +/** + * A dynamically-allocated array of crate::ln::msgs::NetAddresss of arbitrary size. + * This corresponds to std::vector in C++ + */ typedef struct LDKCVec_NetAddressZ { + /** + * The elements in the array. + * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc(). + */ struct LDKNetAddress *data; + /** + * The number of elements pointed to by `data`. + */ uintptr_t datalen; } LDKCVec_NetAddressZ; @@ -1456,25 +2719,65 @@ typedef struct LDKCVec_NetAddressZ { */ typedef struct MUST_USE_STRUCT LDKNodeAnnouncementInfo { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeNodeAnnouncementInfo *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKNodeAnnouncementInfo; +/** + * The contents of CResult_NodeAnnouncementInfoDecodeErrorZ + */ typedef union LDKCResult_NodeAnnouncementInfoDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKNodeAnnouncementInfo *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_NodeAnnouncementInfoDecodeErrorZPtr; +/** + * A CResult_NodeAnnouncementInfoDecodeErrorZ represents the result of a fallible operation, + * containing a crate::routing::network_graph::NodeAnnouncementInfo on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ { + /** + * The contents of this CResult_NodeAnnouncementInfoDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_NodeAnnouncementInfoDecodeErrorZPtr contents; + /** + * Whether this CResult_NodeAnnouncementInfoDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_NodeAnnouncementInfoDecodeErrorZ; +/** + * A dynamically-allocated array of u64s of arbitrary size. + * This corresponds to std::vector in C++ + */ typedef struct LDKCVec_u64Z { + /** + * The elements in the array. + * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc(). + */ uint64_t *data; + /** + * The number of elements pointed to by `data`. + */ uintptr_t datalen; } LDKCVec_u64Z; @@ -1485,20 +2788,49 @@ typedef struct LDKCVec_u64Z { */ typedef struct MUST_USE_STRUCT LDKNodeInfo { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeNodeInfo *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKNodeInfo; +/** + * The contents of CResult_NodeInfoDecodeErrorZ + */ typedef union LDKCResult_NodeInfoDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKNodeInfo *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_NodeInfoDecodeErrorZPtr; +/** + * A CResult_NodeInfoDecodeErrorZ represents the result of a fallible operation, + * containing a crate::routing::network_graph::NodeInfo on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_NodeInfoDecodeErrorZ { + /** + * The contents of this CResult_NodeInfoDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_NodeInfoDecodeErrorZPtr contents; + /** + * Whether this CResult_NodeInfoDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_NodeInfoDecodeErrorZ; @@ -1509,43 +2841,111 @@ typedef struct LDKCResult_NodeInfoDecodeErrorZ { */ typedef struct MUST_USE_STRUCT LDKNetworkGraph { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeNetworkGraph *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKNetworkGraph; +/** + * The contents of CResult_NetworkGraphDecodeErrorZ + */ typedef union LDKCResult_NetworkGraphDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKNetworkGraph *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_NetworkGraphDecodeErrorZPtr; +/** + * A CResult_NetworkGraphDecodeErrorZ represents the result of a fallible operation, + * containing a crate::routing::network_graph::NetworkGraph on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_NetworkGraphDecodeErrorZ { + /** + * The contents of this CResult_NetworkGraphDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_NetworkGraphDecodeErrorZPtr contents; + /** + * Whether this CResult_NetworkGraphDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_NetworkGraphDecodeErrorZ; +/** + * A tuple of 2 elements. See the individual fields for the types contained. + */ typedef struct LDKC2Tuple_usizeTransactionZ { + /** + * The element at position 0 + */ uintptr_t a; + /** + * The element at position 1 + */ struct LDKTransaction b; } LDKC2Tuple_usizeTransactionZ; +/** + * A dynamically-allocated array of crate::c_types::derived::C2Tuple_usizeTransactionZs of arbitrary size. + * This corresponds to std::vector in C++ + */ typedef struct LDKCVec_C2Tuple_usizeTransactionZZ { + /** + * The elements in the array. + * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc(). + */ struct LDKC2Tuple_usizeTransactionZ *data; + /** + * The number of elements pointed to by `data`. + */ uintptr_t datalen; } LDKCVec_C2Tuple_usizeTransactionZZ; +/** + * The contents of CResult_NoneChannelMonitorUpdateErrZ + */ typedef union LDKCResult_NoneChannelMonitorUpdateErrZPtr { /** * Note that this value is always NULL, as there are no contents in the OK variant */ void *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ enum LDKChannelMonitorUpdateErr *err; } LDKCResult_NoneChannelMonitorUpdateErrZPtr; +/** + * A CResult_NoneChannelMonitorUpdateErrZ represents the result of a fallible operation, + * containing a () on success and a crate::chain::channelmonitor::ChannelMonitorUpdateErr on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_NoneChannelMonitorUpdateErrZ { + /** + * The contents of this CResult_NoneChannelMonitorUpdateErrZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_NoneChannelMonitorUpdateErrZPtr contents; + /** + * Whether this CResult_NoneChannelMonitorUpdateErrZ represents a success state. + */ bool result_ok; } LDKCResult_NoneChannelMonitorUpdateErrZ; @@ -1555,15 +2955,19 @@ typedef struct LDKCResult_NoneChannelMonitorUpdateErrZ { * Simple structure sent back by `chain::Watch` when an HTLC from a forward channel is detected on * chain. Used to update the corresponding HTLC in the backward channel. Failing to pass the * preimage claim backward will lead to loss of funds. - * - * [`chain::Watch`]: ../trait.Watch.html */ typedef struct MUST_USE_STRUCT LDKHTLCUpdate { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeHTLCUpdate *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKHTLCUpdate; @@ -1577,10 +2981,16 @@ typedef struct MUST_USE_STRUCT LDKHTLCUpdate { */ typedef struct MUST_USE_STRUCT LDKOutPoint { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeOutPoint *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKOutPoint; @@ -1614,8 +3024,19 @@ typedef struct MUST_USE_STRUCT LDKMonitorEvent { }; } LDKMonitorEvent; +/** + * A dynamically-allocated array of crate::chain::channelmonitor::MonitorEvents of arbitrary size. + * This corresponds to std::vector in C++ + */ typedef struct LDKCVec_MonitorEventZ { + /** + * The elements in the array. + * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc(). + */ struct LDKMonitorEvent *data; + /** + * The number of elements pointed to by `data`. + */ uintptr_t datalen; } LDKCVec_MonitorEventZ; @@ -1627,10 +3048,16 @@ typedef struct LDKCVec_MonitorEventZ { */ typedef struct MUST_USE_STRUCT LDKDelayedPaymentOutputDescriptor { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeDelayedPaymentOutputDescriptor *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKDelayedPaymentOutputDescriptor; @@ -1642,10 +3069,16 @@ typedef struct MUST_USE_STRUCT LDKDelayedPaymentOutputDescriptor { */ typedef struct MUST_USE_STRUCT LDKStaticPaymentOutputDescriptor { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeStaticPaymentOutputDescriptor *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKStaticPaymentOutputDescriptor; @@ -1713,7 +3146,13 @@ typedef enum LDKSpendableOutputDescriptor_Tag { } LDKSpendableOutputDescriptor_Tag; typedef struct LDKSpendableOutputDescriptor_LDKStaticOutput_Body { + /** + * The outpoint which is spendable + */ struct LDKOutPoint outpoint; + /** + * The output which is referenced by the given outpoint. + */ struct LDKTxOut output; } LDKSpendableOutputDescriptor_LDKStaticOutput_Body; @@ -1730,8 +3169,19 @@ typedef struct MUST_USE_STRUCT LDKSpendableOutputDescriptor { }; } LDKSpendableOutputDescriptor; +/** + * A dynamically-allocated array of crate::chain::keysinterface::SpendableOutputDescriptors of arbitrary size. + * This corresponds to std::vector in C++ + */ typedef struct LDKCVec_SpendableOutputDescriptorZ { + /** + * The elements in the array. + * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc(). + */ struct LDKSpendableOutputDescriptor *data; + /** + * The number of elements pointed to by `data`. + */ uintptr_t datalen; } LDKCVec_SpendableOutputDescriptorZ; @@ -1803,37 +3253,98 @@ typedef enum LDKEvent_Tag { } LDKEvent_Tag; typedef struct LDKEvent_LDKFundingGenerationReady_Body { - struct LDKThirtyTwoBytes temporary_channel_id; + /** + * The random channel_id we picked which you'll need to pass into + * ChannelManager::funding_transaction_generated. + */ + struct LDKThirtyTwoBytes temporary_channel_id; + /** + * The value, in satoshis, that the output should have. + */ uint64_t channel_value_satoshis; + /** + * The script which should be used in the transaction output. + */ struct LDKCVec_u8Z output_script; + /** + * The value passed in to ChannelManager::create_channel + */ uint64_t user_channel_id; } LDKEvent_LDKFundingGenerationReady_Body; typedef struct LDKEvent_LDKFundingBroadcastSafe_Body { + /** + * The output, which was passed to ChannelManager::funding_transaction_generated, which is + * now safe to broadcast. + */ struct LDKOutPoint funding_txo; + /** + * The value passed in to ChannelManager::create_channel + */ uint64_t user_channel_id; } LDKEvent_LDKFundingBroadcastSafe_Body; typedef struct LDKEvent_LDKPaymentReceived_Body { + /** + * The hash for which the preimage should be handed to the ChannelManager. + */ struct LDKThirtyTwoBytes payment_hash; + /** + * The \"payment secret\". This authenticates the sender to the recipient, preventing a + * number of deanonymization attacks during the routing process. + * As nodes upgrade, the invoices you provide should likely migrate to setting the + * payment_secret feature to required, at which point you should fail_backwards any HTLCs + * which have a None here. + * Until then, however, values of None should be ignored, and only incorrect Some values + * should result in an HTLC fail_backwards. + * Note that, in any case, this value must be passed as-is to any fail or claim calls as + * the HTLC index includes this value. + */ struct LDKThirtyTwoBytes payment_secret; + /** + * The value, in thousandths of a satoshi, that this payment is for. Note that you must + * compare this to the expected value before accepting the payment (as otherwise you are + * providing proof-of-payment for less than the value you expected!). + */ uint64_t amt; } LDKEvent_LDKPaymentReceived_Body; typedef struct LDKEvent_LDKPaymentSent_Body { + /** + * The preimage to the hash given to ChannelManager::send_payment. + * Note that this serves as a payment receipt, if you wish to have such a thing, you must + * store it somehow! + */ struct LDKThirtyTwoBytes payment_preimage; } LDKEvent_LDKPaymentSent_Body; typedef struct LDKEvent_LDKPaymentFailed_Body { + /** + * The hash which was given to ChannelManager::send_payment. + */ struct LDKThirtyTwoBytes payment_hash; + /** + * Indicates the payment was rejected for some reason by the recipient. This implies that + * the payment has failed, not just the route in question. If this is not set, you may + * retry the payment via a different route. + */ bool rejected_by_dest; } LDKEvent_LDKPaymentFailed_Body; typedef struct LDKEvent_LDKPendingHTLCsForwardable_Body { + /** + * The minimum amount of time that should be waited prior to calling + * process_pending_htlc_forwards. To increase the effort required to correlate payments, + * you should wait a random amount of time in roughly the range (now + time_forwardable, + * now + 5*time_forwardable). + */ uint64_t time_forwardable; } LDKEvent_LDKPendingHTLCsForwardable_Body; typedef struct LDKEvent_LDKSpendableOutputs_Body { + /** + * The outputs which you should store as spendable by you. + */ struct LDKCVec_SpendableOutputDescriptorZ outputs; } LDKEvent_LDKSpendableOutputs_Body; @@ -1850,18 +3361,52 @@ typedef struct MUST_USE_STRUCT LDKEvent { }; } LDKEvent; +/** + * A dynamically-allocated array of crate::util::events::Events of arbitrary size. + * This corresponds to std::vector in C++ + */ typedef struct LDKCVec_EventZ { + /** + * The elements in the array. + * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc(). + */ struct LDKEvent *data; + /** + * The number of elements pointed to by `data`. + */ uintptr_t datalen; } LDKCVec_EventZ; +/** + * The contents of CResult_OutPointDecodeErrorZ + */ typedef union LDKCResult_OutPointDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKOutPoint *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_OutPointDecodeErrorZPtr; +/** + * A CResult_OutPointDecodeErrorZ represents the result of a fallible operation, + * containing a crate::chain::transaction::OutPoint on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_OutPointDecodeErrorZ { + /** + * The contents of this CResult_OutPointDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_OutPointDecodeErrorZPtr contents; + /** + * Whether this CResult_OutPointDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_OutPointDecodeErrorZ; @@ -1873,30 +3418,82 @@ typedef struct LDKCResult_OutPointDecodeErrorZ { */ typedef struct MUST_USE_STRUCT LDKChannelMonitorUpdate { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeChannelMonitorUpdate *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKChannelMonitorUpdate; +/** + * The contents of CResult_ChannelMonitorUpdateDecodeErrorZ + */ typedef union LDKCResult_ChannelMonitorUpdateDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKChannelMonitorUpdate *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_ChannelMonitorUpdateDecodeErrorZPtr; +/** + * A CResult_ChannelMonitorUpdateDecodeErrorZ represents the result of a fallible operation, + * containing a crate::chain::channelmonitor::ChannelMonitorUpdate on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ { + /** + * The contents of this CResult_ChannelMonitorUpdateDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_ChannelMonitorUpdateDecodeErrorZPtr contents; + /** + * Whether this CResult_ChannelMonitorUpdateDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_ChannelMonitorUpdateDecodeErrorZ; +/** + * The contents of CResult_HTLCUpdateDecodeErrorZ + */ typedef union LDKCResult_HTLCUpdateDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKHTLCUpdate *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_HTLCUpdateDecodeErrorZPtr; +/** + * A CResult_HTLCUpdateDecodeErrorZ represents the result of a fallible operation, + * containing a crate::chain::channelmonitor::HTLCUpdate on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_HTLCUpdateDecodeErrorZ { + /** + * The contents of this CResult_HTLCUpdateDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_HTLCUpdateDecodeErrorZPtr contents; + /** + * Whether this CResult_HTLCUpdateDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_HTLCUpdateDecodeErrorZ; @@ -1911,62 +3508,223 @@ typedef struct LDKCResult_HTLCUpdateDecodeErrorZ { */ typedef struct MUST_USE_STRUCT LDKMonitorUpdateError { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeMonitorUpdateError *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKMonitorUpdateError; +/** + * The contents of CResult_NoneMonitorUpdateErrorZ + */ typedef union LDKCResult_NoneMonitorUpdateErrorZPtr { /** * Note that this value is always NULL, as there are no contents in the OK variant */ void *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKMonitorUpdateError *err; } LDKCResult_NoneMonitorUpdateErrorZPtr; +/** + * A CResult_NoneMonitorUpdateErrorZ represents the result of a fallible operation, + * containing a () on success and a crate::chain::channelmonitor::MonitorUpdateError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_NoneMonitorUpdateErrorZ { + /** + * The contents of this CResult_NoneMonitorUpdateErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_NoneMonitorUpdateErrorZPtr contents; + /** + * Whether this CResult_NoneMonitorUpdateErrorZ represents a success state. + */ bool result_ok; } LDKCResult_NoneMonitorUpdateErrorZ; +/** + * A tuple of 2 elements. See the individual fields for the types contained. + */ typedef struct LDKC2Tuple_OutPointScriptZ { + /** + * The element at position 0 + */ struct LDKOutPoint a; + /** + * The element at position 1 + */ struct LDKCVec_u8Z b; } LDKC2Tuple_OutPointScriptZ; +/** + * A tuple of 2 elements. See the individual fields for the types contained. + */ +typedef struct LDKC2Tuple_u32ScriptZ { + /** + * The element at position 0 + */ + uint32_t a; + /** + * The element at position 1 + */ + struct LDKCVec_u8Z b; +} LDKC2Tuple_u32ScriptZ; + +/** + * A dynamically-allocated array of crate::c_types::derived::C2Tuple_u32ScriptZs of arbitrary size. + * This corresponds to std::vector in C++ + */ +typedef struct LDKCVec_C2Tuple_u32ScriptZZ { + /** + * The elements in the array. + * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc(). + */ + struct LDKC2Tuple_u32ScriptZ *data; + /** + * The number of elements pointed to by `data`. + */ + uintptr_t datalen; +} LDKCVec_C2Tuple_u32ScriptZZ; + +/** + * A tuple of 2 elements. See the individual fields for the types contained. + */ +typedef struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ { + /** + * The element at position 0 + */ + struct LDKThirtyTwoBytes a; + /** + * The element at position 1 + */ + struct LDKCVec_C2Tuple_u32ScriptZZ b; +} LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ; + +/** + * A dynamically-allocated array of crate::c_types::derived::C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZs of arbitrary size. + * This corresponds to std::vector in C++ + */ +typedef struct LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ { + /** + * The elements in the array. + * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc(). + */ + struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ *data; + /** + * The number of elements pointed to by `data`. + */ + uintptr_t datalen; +} LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ; + +/** + * A dynamically-allocated array of crate::c_types::Transactions of arbitrary size. + * This corresponds to std::vector in C++ + */ typedef struct LDKCVec_TransactionZ { + /** + * The elements in the array. + * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc(). + */ struct LDKTransaction *data; + /** + * The number of elements pointed to by `data`. + */ uintptr_t datalen; } LDKCVec_TransactionZ; +/** + * A tuple of 2 elements. See the individual fields for the types contained. + */ typedef struct LDKC2Tuple_u32TxOutZ { + /** + * The element at position 0 + */ uint32_t a; + /** + * The element at position 1 + */ struct LDKTxOut b; } LDKC2Tuple_u32TxOutZ; +/** + * A dynamically-allocated array of crate::c_types::derived::C2Tuple_u32TxOutZs of arbitrary size. + * This corresponds to std::vector in C++ + */ typedef struct LDKCVec_C2Tuple_u32TxOutZZ { + /** + * The elements in the array. + * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc(). + */ struct LDKC2Tuple_u32TxOutZ *data; + /** + * The number of elements pointed to by `data`. + */ uintptr_t datalen; } LDKCVec_C2Tuple_u32TxOutZZ; +/** + * A tuple of 2 elements. See the individual fields for the types contained. + */ typedef struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ { + /** + * The element at position 0 + */ struct LDKThirtyTwoBytes a; + /** + * The element at position 1 + */ struct LDKCVec_C2Tuple_u32TxOutZZ b; } LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ; +/** + * A dynamically-allocated array of crate::c_types::derived::C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZs of arbitrary size. + * This corresponds to std::vector in C++ + */ typedef struct LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZZ { + /** + * The elements in the array. + * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc(). + */ struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ *data; + /** + * The number of elements pointed to by `data`. + */ uintptr_t datalen; } LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZZ; +/** + * A tuple of 2 elements. See the individual fields for the types contained. + */ typedef struct LDKC2Tuple_SignatureCVec_SignatureZZ { + /** + * The element at position 0 + */ struct LDKSignature a; + /** + * The element at position 1 + */ struct LDKCVec_SignatureZ b; } LDKC2Tuple_SignatureCVec_SignatureZZ; +/** + * The contents of CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ + */ typedef union LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKC2Tuple_SignatureCVec_SignatureZZ *result; /** * Note that this value is always NULL, as there are no contents in the Err variant @@ -1974,12 +3732,31 @@ typedef union LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZPtr { void *err; } LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZPtr; +/** + * A CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ represents the result of a fallible operation, + * containing a crate::c_types::derived::C2Tuple_SignatureCVec_SignatureZZ on success and a () on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ { + /** + * The contents of this CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZPtr contents; + /** + * Whether this CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ represents a success state. + */ bool result_ok; } LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ; +/** + * The contents of CResult_SignatureNoneZ + */ typedef union LDKCResult_SignatureNoneZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKSignature *result; /** * Note that this value is always NULL, as there are no contents in the Err variant @@ -1987,8 +3764,20 @@ typedef union LDKCResult_SignatureNoneZPtr { void *err; } LDKCResult_SignatureNoneZPtr; +/** + * A CResult_SignatureNoneZ represents the result of a fallible operation, + * containing a crate::c_types::Signature on success and a () on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_SignatureNoneZ { + /** + * The contents of this CResult_SignatureNoneZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_SignatureNoneZPtr contents; + /** + * Whether this CResult_SignatureNoneZ represents a success state. + */ bool result_ok; } LDKCResult_SignatureNoneZ; @@ -1999,10 +3788,16 @@ typedef struct LDKCResult_SignatureNoneZ { */ typedef struct MUST_USE_STRUCT LDKUnsignedChannelAnnouncement { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeUnsignedChannelAnnouncement *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKUnsignedChannelAnnouncement; @@ -2026,6 +3821,10 @@ typedef struct MUST_USE_STRUCT LDKUnsignedChannelAnnouncement { * of LN security model, orthogonal of key management issues. */ typedef struct LDKSign { + /** + * An opaque pointer which is passed to your function implementations as an argument. + * This has no meaning in the LDK, and can be NULL or any other value. + */ void *this_arg; /** * Gets the per-commitment point for a specific commitment number @@ -2150,8 +3949,20 @@ typedef struct LDKSign { * Will be called before any signatures are applied. */ void (*ready_channel)(void *this_arg, const struct LDKChannelTransactionParameters *NONNULL_PTR channel_parameters); + /** + * Creates a copy of the object pointed to by this_arg, for a copy of this Sign. + * Note that the ultimate copy of the Sign will have all function pointers the same as the original. + * May be NULL if no action needs to be taken, the this_arg pointer will be copied into the new Sign. + */ void *(*clone)(const void *this_arg); + /** + * Serialize the object into a byte array + */ struct LDKCVec_u8Z (*write)(const void *this_arg); + /** + * Frees any resources associated with this object given its this_arg pointer. + * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed. + */ void (*free)(void *this_arg); } LDKSign; @@ -2177,44 +3988,138 @@ typedef struct LDKSign { */ typedef struct MUST_USE_STRUCT LDKChannelMonitor { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeChannelMonitor *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKChannelMonitor; +/** + * A tuple of 2 elements. See the individual fields for the types contained. + */ typedef struct LDKC2Tuple_BlockHashChannelMonitorZ { + /** + * The element at position 0 + */ struct LDKThirtyTwoBytes a; + /** + * The element at position 1 + */ struct LDKChannelMonitor b; } LDKC2Tuple_BlockHashChannelMonitorZ; +/** + * The contents of CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ + */ typedef union LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKC2Tuple_BlockHashChannelMonitorZ *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZPtr; +/** + * A CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ represents the result of a fallible operation, + * containing a crate::c_types::derived::C2Tuple_BlockHashChannelMonitorZ on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ { + /** + * The contents of this CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZPtr contents; + /** + * Whether this CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ; +/** + * The contents of CResult_TxOutAccessErrorZ + */ typedef union LDKCResult_TxOutAccessErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKTxOut *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ enum LDKAccessError *err; } LDKCResult_TxOutAccessErrorZPtr; +/** + * A CResult_TxOutAccessErrorZ represents the result of a fallible operation, + * containing a crate::c_types::TxOut on success and a crate::chain::AccessError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_TxOutAccessErrorZ { + /** + * The contents of this CResult_TxOutAccessErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_TxOutAccessErrorZPtr contents; + /** + * Whether this CResult_TxOutAccessErrorZ represents a success state. + */ bool result_ok; } LDKCResult_TxOutAccessErrorZ; +/** + * An enum which can either contain a crate::c_types::derived::C2Tuple_usizeTransactionZ or not + */ +typedef enum LDKCOption_C2Tuple_usizeTransactionZZ_Tag { + /** + * When we're in this state, this COption_C2Tuple_usizeTransactionZZ contains a crate::c_types::derived::C2Tuple_usizeTransactionZ + */ + LDKCOption_C2Tuple_usizeTransactionZZ_Some, + /** + * When we're in this state, this COption_C2Tuple_usizeTransactionZZ contains nothing + */ + LDKCOption_C2Tuple_usizeTransactionZZ_None, + /** + * Must be last for serialization purposes + */ + LDKCOption_C2Tuple_usizeTransactionZZ_Sentinel, +} LDKCOption_C2Tuple_usizeTransactionZZ_Tag; + +typedef struct LDKCOption_C2Tuple_usizeTransactionZZ { + LDKCOption_C2Tuple_usizeTransactionZZ_Tag tag; + union { + struct { + struct LDKC2Tuple_usizeTransactionZ some; + }; + }; +} LDKCOption_C2Tuple_usizeTransactionZZ; + /** * A Rust str object, ie a reference to a UTF8-valid string. * This is *not* null-terminated so cannot be used directly as a C string! */ typedef struct LDKStr { + /** + * A pointer to the string's bytes, in UTF8 encoding + */ const uint8_t *chars; + /** + * The number of bytes (not characters!) pointed to by `chars` + */ uintptr_t len; } LDKStr; @@ -2257,19 +4162,34 @@ typedef enum LDKAPIError_Tag { } LDKAPIError_Tag; typedef struct LDKAPIError_LDKAPIMisuseError_Body { + /** + * A human-readable error message + */ struct LDKCVec_u8Z err; } LDKAPIError_LDKAPIMisuseError_Body; typedef struct LDKAPIError_LDKFeeRateTooHigh_Body { + /** + * A human-readable error message + */ struct LDKCVec_u8Z err; + /** + * The feerate which was too high. + */ uint32_t feerate; } LDKAPIError_LDKFeeRateTooHigh_Body; typedef struct LDKAPIError_LDKRouteError_Body { + /** + * A human-readable error message + */ struct LDKStr err; } LDKAPIError_LDKRouteError_Body; typedef struct LDKAPIError_LDKChannelUnavailable_Body { + /** + * A human-readable error message + */ struct LDKCVec_u8Z err; } LDKAPIError_LDKChannelUnavailable_Body; @@ -2283,26 +4203,67 @@ typedef struct MUST_USE_STRUCT LDKAPIError { }; } LDKAPIError; +/** + * The contents of CResult_NoneAPIErrorZ + */ typedef union LDKCResult_NoneAPIErrorZPtr { /** * Note that this value is always NULL, as there are no contents in the OK variant */ void *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKAPIError *err; } LDKCResult_NoneAPIErrorZPtr; -typedef struct LDKCResult_NoneAPIErrorZ { +/** + * A CResult_NoneAPIErrorZ represents the result of a fallible operation, + * containing a () on success and a crate::util::errors::APIError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ +typedef struct LDKCResult_NoneAPIErrorZ { + /** + * The contents of this CResult_NoneAPIErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_NoneAPIErrorZPtr contents; + /** + * Whether this CResult_NoneAPIErrorZ represents a success state. + */ bool result_ok; } LDKCResult_NoneAPIErrorZ; +/** + * A dynamically-allocated array of crate::c_types::derived::CResult_NoneAPIErrorZs of arbitrary size. + * This corresponds to std::vector in C++ + */ typedef struct LDKCVec_CResult_NoneAPIErrorZZ { + /** + * The elements in the array. + * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc(). + */ struct LDKCResult_NoneAPIErrorZ *data; + /** + * The number of elements pointed to by `data`. + */ uintptr_t datalen; } LDKCVec_CResult_NoneAPIErrorZZ; +/** + * A dynamically-allocated array of crate::util::errors::APIErrors of arbitrary size. + * This corresponds to std::vector in C++ + */ typedef struct LDKCVec_APIErrorZ { + /** + * The elements in the array. + * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc(). + */ struct LDKAPIError *data; + /** + * The number of elements pointed to by `data`. + */ uintptr_t datalen; } LDKCVec_APIErrorZ; @@ -2313,15 +4274,32 @@ typedef struct LDKCVec_APIErrorZ { */ typedef struct MUST_USE_STRUCT LDKChannelDetails { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeChannelDetails *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKChannelDetails; +/** + * A dynamically-allocated array of crate::ln::channelmanager::ChannelDetailss of arbitrary size. + * This corresponds to std::vector in C++ + */ typedef struct LDKCVec_ChannelDetailsZ { + /** + * The elements in the array. + * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc(). + */ struct LDKChannelDetails *data; + /** + * The number of elements pointed to by `data`. + */ uintptr_t datalen; } LDKCVec_ChannelDetailsZ; @@ -2392,21 +4370,51 @@ typedef struct MUST_USE_STRUCT LDKPaymentSendFailure { }; } LDKPaymentSendFailure; +/** + * The contents of CResult_NonePaymentSendFailureZ + */ typedef union LDKCResult_NonePaymentSendFailureZPtr { /** * Note that this value is always NULL, as there are no contents in the OK variant */ void *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKPaymentSendFailure *err; } LDKCResult_NonePaymentSendFailureZPtr; +/** + * A CResult_NonePaymentSendFailureZ represents the result of a fallible operation, + * containing a () on success and a crate::ln::channelmanager::PaymentSendFailure on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_NonePaymentSendFailureZ { + /** + * The contents of this CResult_NonePaymentSendFailureZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_NonePaymentSendFailureZPtr contents; + /** + * Whether this CResult_NonePaymentSendFailureZ represents a success state. + */ bool result_ok; } LDKCResult_NonePaymentSendFailureZ; +/** + * A dynamically-allocated array of crate::chain::channelmonitor::ChannelMonitors of arbitrary size. + * This corresponds to std::vector in C++ + */ typedef struct LDKCVec_ChannelMonitorZ { + /** + * The elements in the array. + * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc(). + */ struct LDKChannelMonitor *data; + /** + * The number of elements pointed to by `data`. + */ uintptr_t datalen; } LDKCVec_ChannelMonitorZ; @@ -2429,11 +4437,15 @@ typedef struct LDKCVec_ChannelMonitorZ { * funds in the channel. See [`ChannelMonitorUpdateErr`] for more details about how to handle * multiple instances. * - * [`ChannelMonitor`]: channelmonitor/struct.ChannelMonitor.html - * [`ChannelMonitorUpdateErr`]: channelmonitor/enum.ChannelMonitorUpdateErr.html - * [`PermanentFailure`]: channelmonitor/enum.ChannelMonitorUpdateErr.html#variant.PermanentFailure + * [`ChannelMonitor`]: channelmonitor::ChannelMonitor + * [`ChannelMonitorUpdateErr`]: channelmonitor::ChannelMonitorUpdateErr + * [`PermanentFailure`]: channelmonitor::ChannelMonitorUpdateErr::PermanentFailure */ typedef struct LDKWatch { + /** + * An opaque pointer which is passed to your function implementations as an argument. + * This has no meaning in the LDK, and can be NULL or any other value. + */ void *this_arg; /** * Watches a channel identified by `funding_txo` using `monitor`. @@ -2442,9 +4454,9 @@ typedef struct LDKWatch { * with any spends of outputs returned by [`get_outputs_to_watch`]. In practice, this means * calling [`block_connected`] and [`block_disconnected`] on the monitor. * - * [`get_outputs_to_watch`]: channelmonitor/struct.ChannelMonitor.html#method.get_outputs_to_watch - * [`block_connected`]: channelmonitor/struct.ChannelMonitor.html#method.block_connected - * [`block_disconnected`]: channelmonitor/struct.ChannelMonitor.html#method.block_disconnected + * [`get_outputs_to_watch`]: channelmonitor::ChannelMonitor::get_outputs_to_watch + * [`block_connected`]: channelmonitor::ChannelMonitor::block_connected + * [`block_disconnected`]: channelmonitor::ChannelMonitor::block_disconnected */ struct LDKCResult_NoneChannelMonitorUpdateErrZ (*watch_channel)(const void *this_arg, struct LDKOutPoint funding_txo, struct LDKChannelMonitor monitor); /** @@ -2453,8 +4465,8 @@ typedef struct LDKWatch { * Implementations must call [`update_monitor`] with the given update. See * [`ChannelMonitorUpdateErr`] for invariants around returning an error. * - * [`update_monitor`]: channelmonitor/struct.ChannelMonitor.html#method.update_monitor - * [`ChannelMonitorUpdateErr`]: channelmonitor/enum.ChannelMonitorUpdateErr.html + * [`update_monitor`]: channelmonitor::ChannelMonitor::update_monitor + * [`ChannelMonitorUpdateErr`]: channelmonitor::ChannelMonitorUpdateErr */ struct LDKCResult_NoneChannelMonitorUpdateErrZ (*update_channel)(const void *this_arg, struct LDKOutPoint funding_txo, struct LDKChannelMonitorUpdate update); /** @@ -2462,6 +4474,10 @@ typedef struct LDKWatch { * events. */ struct LDKCVec_MonitorEventZ (*release_pending_monitor_events)(const void *this_arg); + /** + * Frees any resources associated with this object given its this_arg pointer. + * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed. + */ void (*free)(void *this_arg); } LDKWatch; @@ -2469,26 +4485,67 @@ typedef struct LDKWatch { * An interface to send a transaction to the Bitcoin network. */ typedef struct LDKBroadcasterInterface { + /** + * An opaque pointer which is passed to your function implementations as an argument. + * This has no meaning in the LDK, and can be NULL or any other value. + */ void *this_arg; /** * Sends a transaction out to (hopefully) be mined. */ void (*broadcast_transaction)(const void *this_arg, struct LDKTransaction tx); + /** + * Frees any resources associated with this object given its this_arg pointer. + * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed. + */ void (*free)(void *this_arg); } LDKBroadcasterInterface; +/** + * The contents of CResult_SignDecodeErrorZ + */ typedef union LDKCResult_SignDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKSign *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_SignDecodeErrorZPtr; +/** + * A CResult_SignDecodeErrorZ represents the result of a fallible operation, + * containing a crate::chain::keysinterface::Sign on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_SignDecodeErrorZ { + /** + * The contents of this CResult_SignDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_SignDecodeErrorZPtr contents; + /** + * Whether this CResult_SignDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_SignDecodeErrorZ; +/** + * A "slice" referencing some byte array. This is simply a length-tagged pointer which does not + * own the memory pointed to by data. + */ typedef struct LDKu8slice { + /** + * A pointer to the byte buffer + */ const uint8_t *data; + /** + * The number of bytes pointed to by `data`. + */ uintptr_t datalen; } LDKu8slice; @@ -2496,6 +4553,10 @@ typedef struct LDKu8slice { * A trait to describe an object which can get user secrets and key material. */ typedef struct LDKKeysInterface { + /** + * An opaque pointer which is passed to your function implementations as an argument. + * This has no meaning in the LDK, and can be NULL or any other value. + */ void *this_arg; /** * Get node secret key (aka node_id or network_key). @@ -2542,6 +4603,10 @@ typedef struct LDKKeysInterface { * you've read all of the provided bytes to ensure no corruption occurred. */ struct LDKCResult_SignDecodeErrorZ (*read_chan_signer)(const void *this_arg, struct LDKu8slice reader); + /** + * Frees any resources associated with this object given its this_arg pointer. + * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed. + */ void (*free)(void *this_arg); } LDKKeysInterface; @@ -2553,6 +4618,10 @@ typedef struct LDKKeysInterface { * called from inside the library in response to chain events, P2P events, or timer events). */ typedef struct LDKFeeEstimator { + /** + * An opaque pointer which is passed to your function implementations as an argument. + * This has no meaning in the LDK, and can be NULL or any other value. + */ void *this_arg; /** * Gets estimated satoshis of fee required per 1000 Weight-Units. @@ -2565,6 +4634,10 @@ typedef struct LDKFeeEstimator { * * ceil(satoshis-per-kbyte / 4) */ uint32_t (*get_est_sat_per_1000_weight)(const void *this_arg, enum LDKConfirmationTarget confirmation_target); + /** + * Frees any resources associated with this object given its this_arg pointer. + * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed. + */ void (*free)(void *this_arg); } LDKFeeEstimator; @@ -2572,11 +4645,19 @@ typedef struct LDKFeeEstimator { * A trait encapsulating the operations required of a logger */ typedef struct LDKLogger { + /** + * An opaque pointer which is passed to your function implementations as an argument. + * This has no meaning in the LDK, and can be NULL or any other value. + */ void *this_arg; /** * Logs the `Record` */ void (*log)(const void *this_arg, const char *record); + /** + * Frees any resources associated with this object given its this_arg pointer. + * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed. + */ void (*free)(void *this_arg); } LDKLogger; @@ -2622,44 +4703,123 @@ typedef struct LDKLogger { */ typedef struct MUST_USE_STRUCT LDKChannelManager { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeChannelManager *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKChannelManager; +/** + * A tuple of 2 elements. See the individual fields for the types contained. + */ typedef struct LDKC2Tuple_BlockHashChannelManagerZ { + /** + * The element at position 0 + */ struct LDKThirtyTwoBytes a; + /** + * The element at position 1 + */ struct LDKChannelManager b; } LDKC2Tuple_BlockHashChannelManagerZ; +/** + * The contents of CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ + */ typedef union LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKC2Tuple_BlockHashChannelManagerZ *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZPtr; +/** + * A CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ represents the result of a fallible operation, + * containing a crate::c_types::derived::C2Tuple_BlockHashChannelManagerZ on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ { + /** + * The contents of this CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZPtr contents; + /** + * Whether this CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ; +/** + * The contents of CResult_SpendableOutputDescriptorDecodeErrorZ + */ typedef union LDKCResult_SpendableOutputDescriptorDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKSpendableOutputDescriptor *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_SpendableOutputDescriptorDecodeErrorZPtr; +/** + * A CResult_SpendableOutputDescriptorDecodeErrorZ represents the result of a fallible operation, + * containing a crate::chain::keysinterface::SpendableOutputDescriptor on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ { + /** + * The contents of this CResult_SpendableOutputDescriptorDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_SpendableOutputDescriptorDecodeErrorZPtr contents; + /** + * Whether this CResult_SpendableOutputDescriptorDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_SpendableOutputDescriptorDecodeErrorZ; +/** + * A dynamically-allocated array of crate::c_types::derived::CVec_u8Zs of arbitrary size. + * This corresponds to std::vector in C++ + */ typedef struct LDKCVec_CVec_u8ZZ { + /** + * The elements in the array. + * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc(). + */ struct LDKCVec_u8Z *data; + /** + * The number of elements pointed to by `data`. + */ uintptr_t datalen; } LDKCVec_CVec_u8ZZ; +/** + * The contents of CResult_CVec_CVec_u8ZZNoneZ + */ typedef union LDKCResult_CVec_CVec_u8ZZNoneZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKCVec_CVec_u8ZZ *result; /** * Note that this value is always NULL, as there are no contents in the Err variant @@ -2667,8 +4827,20 @@ typedef union LDKCResult_CVec_CVec_u8ZZNoneZPtr { void *err; } LDKCResult_CVec_CVec_u8ZZNoneZPtr; +/** + * A CResult_CVec_CVec_u8ZZNoneZ represents the result of a fallible operation, + * containing a crate::c_types::derived::CVec_CVec_u8ZZ on success and a () on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_CVec_CVec_u8ZZNoneZ { + /** + * The contents of this CResult_CVec_CVec_u8ZZNoneZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_CVec_CVec_u8ZZNoneZPtr contents; + /** + * Whether this CResult_CVec_CVec_u8ZZNoneZ represents a success state. + */ bool result_ok; } LDKCResult_CVec_CVec_u8ZZNoneZ; @@ -2682,29 +4854,76 @@ typedef struct LDKCResult_CVec_CVec_u8ZZNoneZ { */ typedef struct MUST_USE_STRUCT LDKInMemorySigner { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeInMemorySigner *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKInMemorySigner; +/** + * The contents of CResult_InMemorySignerDecodeErrorZ + */ typedef union LDKCResult_InMemorySignerDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKInMemorySigner *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_InMemorySignerDecodeErrorZPtr; +/** + * A CResult_InMemorySignerDecodeErrorZ represents the result of a fallible operation, + * containing a crate::chain::keysinterface::InMemorySigner on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_InMemorySignerDecodeErrorZ { + /** + * The contents of this CResult_InMemorySignerDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_InMemorySignerDecodeErrorZPtr contents; + /** + * Whether this CResult_InMemorySignerDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_InMemorySignerDecodeErrorZ; +/** + * A dynamically-allocated array of crate::c_types::TxOuts of arbitrary size. + * This corresponds to std::vector in C++ + */ typedef struct LDKCVec_TxOutZ { + /** + * The elements in the array. + * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc(). + */ struct LDKTxOut *data; + /** + * The number of elements pointed to by `data`. + */ uintptr_t datalen; } LDKCVec_TxOutZ; +/** + * The contents of CResult_TransactionNoneZ + */ typedef union LDKCResult_TransactionNoneZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKTransaction *result; /** * Note that this value is always NULL, as there are no contents in the Err variant @@ -2712,8 +4931,20 @@ typedef union LDKCResult_TransactionNoneZPtr { void *err; } LDKCResult_TransactionNoneZPtr; +/** + * A CResult_TransactionNoneZ represents the result of a fallible operation, + * containing a crate::c_types::Transaction on success and a () on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_TransactionNoneZ { + /** + * The contents of this CResult_TransactionNoneZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_TransactionNoneZPtr contents; + /** + * Whether this CResult_TransactionNoneZ represents a success state. + */ bool result_ok; } LDKCResult_TransactionNoneZ; @@ -2724,20 +4955,48 @@ typedef struct LDKCResult_TransactionNoneZ { */ typedef struct MUST_USE_STRUCT LDKRouteHop { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeRouteHop *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKRouteHop; +/** + * A dynamically-allocated array of crate::routing::router::RouteHops of arbitrary size. + * This corresponds to std::vector in C++ + */ typedef struct LDKCVec_RouteHopZ { + /** + * The elements in the array. + * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc(). + */ struct LDKRouteHop *data; + /** + * The number of elements pointed to by `data`. + */ uintptr_t datalen; } LDKCVec_RouteHopZ; +/** + * A dynamically-allocated array of crate::c_types::derived::CVec_RouteHopZs of arbitrary size. + * This corresponds to std::vector in C++ + */ typedef struct LDKCVec_CVec_RouteHopZZ { + /** + * The elements in the array. + * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc(). + */ struct LDKCVec_RouteHopZ *data; + /** + * The number of elements pointed to by `data`. + */ uintptr_t datalen; } LDKCVec_CVec_RouteHopZZ; @@ -2749,20 +5008,49 @@ typedef struct LDKCVec_CVec_RouteHopZZ { */ typedef struct MUST_USE_STRUCT LDKRoute { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeRoute *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKRoute; +/** + * The contents of CResult_RouteDecodeErrorZ + */ typedef union LDKCResult_RouteDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKRoute *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_RouteDecodeErrorZPtr; +/** + * A CResult_RouteDecodeErrorZ represents the result of a fallible operation, + * containing a crate::routing::router::Route on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_RouteDecodeErrorZ { + /** + * The contents of this CResult_RouteDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_RouteDecodeErrorZPtr contents; + /** + * Whether this CResult_RouteDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_RouteDecodeErrorZ; @@ -2773,45 +5061,131 @@ typedef struct LDKCResult_RouteDecodeErrorZ { */ typedef struct MUST_USE_STRUCT LDKRouteHint { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeRouteHint *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKRouteHint; +/** + * A dynamically-allocated array of crate::routing::router::RouteHints of arbitrary size. + * This corresponds to std::vector in C++ + */ typedef struct LDKCVec_RouteHintZ { + /** + * The elements in the array. + * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc(). + */ struct LDKRouteHint *data; + /** + * The number of elements pointed to by `data`. + */ uintptr_t datalen; } LDKCVec_RouteHintZ; +/** + * The contents of CResult_RouteLightningErrorZ + */ typedef union LDKCResult_RouteLightningErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKRoute *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKLightningError *err; } LDKCResult_RouteLightningErrorZPtr; +/** + * A CResult_RouteLightningErrorZ represents the result of a fallible operation, + * containing a crate::routing::router::Route on success and a crate::ln::msgs::LightningError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_RouteLightningErrorZ { + /** + * The contents of this CResult_RouteLightningErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_RouteLightningErrorZPtr contents; + /** + * Whether this CResult_RouteLightningErrorZ represents a success state. + */ bool result_ok; } LDKCResult_RouteLightningErrorZ; +/** + * The contents of CResult_NetAddressu8Z + */ typedef union LDKCResult_NetAddressu8ZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKNetAddress *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ uint8_t *err; } LDKCResult_NetAddressu8ZPtr; +/** + * A CResult_NetAddressu8Z represents the result of a fallible operation, + * containing a crate::ln::msgs::NetAddress on success and a u8 on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_NetAddressu8Z { + /** + * The contents of this CResult_NetAddressu8Z, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_NetAddressu8ZPtr contents; + /** + * Whether this CResult_NetAddressu8Z represents a success state. + */ bool result_ok; } LDKCResult_NetAddressu8Z; +/** + * The contents of CResult_CResult_NetAddressu8ZDecodeErrorZ + */ typedef union LDKCResult_CResult_NetAddressu8ZDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKCResult_NetAddressu8Z *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_CResult_NetAddressu8ZDecodeErrorZPtr; +/** + * A CResult_CResult_NetAddressu8ZDecodeErrorZ represents the result of a fallible operation, + * containing a crate::c_types::derived::CResult_NetAddressu8Z on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ { + /** + * The contents of this CResult_CResult_NetAddressu8ZDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_CResult_NetAddressu8ZDecodeErrorZPtr contents; + /** + * Whether this CResult_CResult_NetAddressu8ZDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_CResult_NetAddressu8ZDecodeErrorZ; @@ -2822,15 +5196,32 @@ typedef struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ { */ typedef struct MUST_USE_STRUCT LDKUpdateAddHTLC { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeUpdateAddHTLC *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKUpdateAddHTLC; +/** + * A dynamically-allocated array of crate::ln::msgs::UpdateAddHTLCs of arbitrary size. + * This corresponds to std::vector in C++ + */ typedef struct LDKCVec_UpdateAddHTLCZ { + /** + * The elements in the array. + * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc(). + */ struct LDKUpdateAddHTLC *data; + /** + * The number of elements pointed to by `data`. + */ uintptr_t datalen; } LDKCVec_UpdateAddHTLCZ; @@ -2841,15 +5232,32 @@ typedef struct LDKCVec_UpdateAddHTLCZ { */ typedef struct MUST_USE_STRUCT LDKUpdateFulfillHTLC { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeUpdateFulfillHTLC *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKUpdateFulfillHTLC; +/** + * A dynamically-allocated array of crate::ln::msgs::UpdateFulfillHTLCs of arbitrary size. + * This corresponds to std::vector in C++ + */ typedef struct LDKCVec_UpdateFulfillHTLCZ { + /** + * The elements in the array. + * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc(). + */ struct LDKUpdateFulfillHTLC *data; + /** + * The number of elements pointed to by `data`. + */ uintptr_t datalen; } LDKCVec_UpdateFulfillHTLCZ; @@ -2860,15 +5268,32 @@ typedef struct LDKCVec_UpdateFulfillHTLCZ { */ typedef struct MUST_USE_STRUCT LDKUpdateFailHTLC { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeUpdateFailHTLC *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKUpdateFailHTLC; +/** + * A dynamically-allocated array of crate::ln::msgs::UpdateFailHTLCs of arbitrary size. + * This corresponds to std::vector in C++ + */ typedef struct LDKCVec_UpdateFailHTLCZ { + /** + * The elements in the array. + * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc(). + */ struct LDKUpdateFailHTLC *data; + /** + * The number of elements pointed to by `data`. + */ uintptr_t datalen; } LDKCVec_UpdateFailHTLCZ; @@ -2879,55 +5304,164 @@ typedef struct LDKCVec_UpdateFailHTLCZ { */ typedef struct MUST_USE_STRUCT LDKUpdateFailMalformedHTLC { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeUpdateFailMalformedHTLC *inner; - bool is_owned; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ + bool is_owned; } LDKUpdateFailMalformedHTLC; +/** + * A dynamically-allocated array of crate::ln::msgs::UpdateFailMalformedHTLCs of arbitrary size. + * This corresponds to std::vector in C++ + */ typedef struct LDKCVec_UpdateFailMalformedHTLCZ { + /** + * The elements in the array. + * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc(). + */ struct LDKUpdateFailMalformedHTLC *data; + /** + * The number of elements pointed to by `data`. + */ uintptr_t datalen; } LDKCVec_UpdateFailMalformedHTLCZ; +/** + * The contents of CResult_AcceptChannelDecodeErrorZ + */ typedef union LDKCResult_AcceptChannelDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKAcceptChannel *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_AcceptChannelDecodeErrorZPtr; +/** + * A CResult_AcceptChannelDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::msgs::AcceptChannel on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_AcceptChannelDecodeErrorZ { + /** + * The contents of this CResult_AcceptChannelDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_AcceptChannelDecodeErrorZPtr contents; + /** + * Whether this CResult_AcceptChannelDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_AcceptChannelDecodeErrorZ; +/** + * The contents of CResult_AnnouncementSignaturesDecodeErrorZ + */ typedef union LDKCResult_AnnouncementSignaturesDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKAnnouncementSignatures *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_AnnouncementSignaturesDecodeErrorZPtr; +/** + * A CResult_AnnouncementSignaturesDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::msgs::AnnouncementSignatures on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_AnnouncementSignaturesDecodeErrorZ { + /** + * The contents of this CResult_AnnouncementSignaturesDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_AnnouncementSignaturesDecodeErrorZPtr contents; + /** + * Whether this CResult_AnnouncementSignaturesDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_AnnouncementSignaturesDecodeErrorZ; +/** + * The contents of CResult_ChannelReestablishDecodeErrorZ + */ typedef union LDKCResult_ChannelReestablishDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKChannelReestablish *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_ChannelReestablishDecodeErrorZPtr; +/** + * A CResult_ChannelReestablishDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::msgs::ChannelReestablish on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_ChannelReestablishDecodeErrorZ { + /** + * The contents of this CResult_ChannelReestablishDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_ChannelReestablishDecodeErrorZPtr contents; + /** + * Whether this CResult_ChannelReestablishDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_ChannelReestablishDecodeErrorZ; +/** + * The contents of CResult_ClosingSignedDecodeErrorZ + */ typedef union LDKCResult_ClosingSignedDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKClosingSigned *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_ClosingSignedDecodeErrorZPtr; +/** + * A CResult_ClosingSignedDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::msgs::ClosingSigned on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_ClosingSignedDecodeErrorZ { + /** + * The contents of this CResult_ClosingSignedDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_ClosingSignedDecodeErrorZPtr contents; + /** + * Whether this CResult_ClosingSignedDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_ClosingSignedDecodeErrorZ; @@ -2938,50 +5472,148 @@ typedef struct LDKCResult_ClosingSignedDecodeErrorZ { */ typedef struct MUST_USE_STRUCT LDKCommitmentSigned { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeCommitmentSigned *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKCommitmentSigned; +/** + * The contents of CResult_CommitmentSignedDecodeErrorZ + */ typedef union LDKCResult_CommitmentSignedDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKCommitmentSigned *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_CommitmentSignedDecodeErrorZPtr; +/** + * A CResult_CommitmentSignedDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::msgs::CommitmentSigned on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_CommitmentSignedDecodeErrorZ { + /** + * The contents of this CResult_CommitmentSignedDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_CommitmentSignedDecodeErrorZPtr contents; + /** + * Whether this CResult_CommitmentSignedDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_CommitmentSignedDecodeErrorZ; +/** + * The contents of CResult_FundingCreatedDecodeErrorZ + */ typedef union LDKCResult_FundingCreatedDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKFundingCreated *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_FundingCreatedDecodeErrorZPtr; +/** + * A CResult_FundingCreatedDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::msgs::FundingCreated on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_FundingCreatedDecodeErrorZ { + /** + * The contents of this CResult_FundingCreatedDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_FundingCreatedDecodeErrorZPtr contents; + /** + * Whether this CResult_FundingCreatedDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_FundingCreatedDecodeErrorZ; +/** + * The contents of CResult_FundingSignedDecodeErrorZ + */ typedef union LDKCResult_FundingSignedDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKFundingSigned *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_FundingSignedDecodeErrorZPtr; +/** + * A CResult_FundingSignedDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::msgs::FundingSigned on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_FundingSignedDecodeErrorZ { + /** + * The contents of this CResult_FundingSignedDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_FundingSignedDecodeErrorZPtr contents; + /** + * Whether this CResult_FundingSignedDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_FundingSignedDecodeErrorZ; +/** + * The contents of CResult_FundingLockedDecodeErrorZ + */ typedef union LDKCResult_FundingLockedDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKFundingLocked *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_FundingLockedDecodeErrorZPtr; +/** + * A CResult_FundingLockedDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::msgs::FundingLocked on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_FundingLockedDecodeErrorZ { + /** + * The contents of this CResult_FundingLockedDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_FundingLockedDecodeErrorZPtr contents; + /** + * Whether this CResult_FundingLockedDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_FundingLockedDecodeErrorZ; @@ -2992,70 +5624,214 @@ typedef struct LDKCResult_FundingLockedDecodeErrorZ { */ typedef struct MUST_USE_STRUCT LDKInit { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeInit *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKInit; +/** + * The contents of CResult_InitDecodeErrorZ + */ typedef union LDKCResult_InitDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKInit *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_InitDecodeErrorZPtr; +/** + * A CResult_InitDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::msgs::Init on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_InitDecodeErrorZ { + /** + * The contents of this CResult_InitDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_InitDecodeErrorZPtr contents; + /** + * Whether this CResult_InitDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_InitDecodeErrorZ; +/** + * The contents of CResult_OpenChannelDecodeErrorZ + */ typedef union LDKCResult_OpenChannelDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKOpenChannel *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_OpenChannelDecodeErrorZPtr; +/** + * A CResult_OpenChannelDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::msgs::OpenChannel on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_OpenChannelDecodeErrorZ { + /** + * The contents of this CResult_OpenChannelDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_OpenChannelDecodeErrorZPtr contents; + /** + * Whether this CResult_OpenChannelDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_OpenChannelDecodeErrorZ; +/** + * The contents of CResult_RevokeAndACKDecodeErrorZ + */ typedef union LDKCResult_RevokeAndACKDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKRevokeAndACK *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_RevokeAndACKDecodeErrorZPtr; +/** + * A CResult_RevokeAndACKDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::msgs::RevokeAndACK on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_RevokeAndACKDecodeErrorZ { + /** + * The contents of this CResult_RevokeAndACKDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_RevokeAndACKDecodeErrorZPtr contents; + /** + * Whether this CResult_RevokeAndACKDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_RevokeAndACKDecodeErrorZ; +/** + * The contents of CResult_ShutdownDecodeErrorZ + */ typedef union LDKCResult_ShutdownDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKShutdown *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_ShutdownDecodeErrorZPtr; +/** + * A CResult_ShutdownDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::msgs::Shutdown on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_ShutdownDecodeErrorZ { + /** + * The contents of this CResult_ShutdownDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_ShutdownDecodeErrorZPtr contents; + /** + * Whether this CResult_ShutdownDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_ShutdownDecodeErrorZ; +/** + * The contents of CResult_UpdateFailHTLCDecodeErrorZ + */ typedef union LDKCResult_UpdateFailHTLCDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKUpdateFailHTLC *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_UpdateFailHTLCDecodeErrorZPtr; +/** + * A CResult_UpdateFailHTLCDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::msgs::UpdateFailHTLC on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_UpdateFailHTLCDecodeErrorZ { + /** + * The contents of this CResult_UpdateFailHTLCDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_UpdateFailHTLCDecodeErrorZPtr contents; + /** + * Whether this CResult_UpdateFailHTLCDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_UpdateFailHTLCDecodeErrorZ; +/** + * The contents of CResult_UpdateFailMalformedHTLCDecodeErrorZ + */ typedef union LDKCResult_UpdateFailMalformedHTLCDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKUpdateFailMalformedHTLC *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_UpdateFailMalformedHTLCDecodeErrorZPtr; +/** + * A CResult_UpdateFailMalformedHTLCDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::msgs::UpdateFailMalformedHTLC on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ { + /** + * The contents of this CResult_UpdateFailMalformedHTLCDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_UpdateFailMalformedHTLCDecodeErrorZPtr contents; + /** + * Whether this CResult_UpdateFailMalformedHTLCDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ; @@ -3066,40 +5842,115 @@ typedef struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ { */ typedef struct MUST_USE_STRUCT LDKUpdateFee { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeUpdateFee *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKUpdateFee; +/** + * The contents of CResult_UpdateFeeDecodeErrorZ + */ typedef union LDKCResult_UpdateFeeDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKUpdateFee *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_UpdateFeeDecodeErrorZPtr; +/** + * A CResult_UpdateFeeDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::msgs::UpdateFee on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_UpdateFeeDecodeErrorZ { + /** + * The contents of this CResult_UpdateFeeDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_UpdateFeeDecodeErrorZPtr contents; + /** + * Whether this CResult_UpdateFeeDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_UpdateFeeDecodeErrorZ; +/** + * The contents of CResult_UpdateFulfillHTLCDecodeErrorZ + */ typedef union LDKCResult_UpdateFulfillHTLCDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKUpdateFulfillHTLC *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_UpdateFulfillHTLCDecodeErrorZPtr; +/** + * A CResult_UpdateFulfillHTLCDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::msgs::UpdateFulfillHTLC on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ { + /** + * The contents of this CResult_UpdateFulfillHTLCDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_UpdateFulfillHTLCDecodeErrorZPtr contents; + /** + * Whether this CResult_UpdateFulfillHTLCDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_UpdateFulfillHTLCDecodeErrorZ; +/** + * The contents of CResult_UpdateAddHTLCDecodeErrorZ + */ typedef union LDKCResult_UpdateAddHTLCDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKUpdateAddHTLC *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_UpdateAddHTLCDecodeErrorZPtr; +/** + * A CResult_UpdateAddHTLCDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::msgs::UpdateAddHTLC on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_UpdateAddHTLCDecodeErrorZ { + /** + * The contents of this CResult_UpdateAddHTLCDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_UpdateAddHTLCDecodeErrorZPtr contents; + /** + * Whether this CResult_UpdateAddHTLCDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_UpdateAddHTLCDecodeErrorZ; @@ -3110,20 +5961,49 @@ typedef struct LDKCResult_UpdateAddHTLCDecodeErrorZ { */ typedef struct MUST_USE_STRUCT LDKPing { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativePing *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKPing; +/** + * The contents of CResult_PingDecodeErrorZ + */ typedef union LDKCResult_PingDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKPing *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_PingDecodeErrorZPtr; +/** + * A CResult_PingDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::msgs::Ping on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_PingDecodeErrorZ { + /** + * The contents of this CResult_PingDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_PingDecodeErrorZPtr contents; + /** + * Whether this CResult_PingDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_PingDecodeErrorZ; @@ -3134,40 +6014,115 @@ typedef struct LDKCResult_PingDecodeErrorZ { */ typedef struct MUST_USE_STRUCT LDKPong { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativePong *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKPong; +/** + * The contents of CResult_PongDecodeErrorZ + */ typedef union LDKCResult_PongDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKPong *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_PongDecodeErrorZPtr; +/** + * A CResult_PongDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::msgs::Pong on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_PongDecodeErrorZ { + /** + * The contents of this CResult_PongDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_PongDecodeErrorZPtr contents; + /** + * Whether this CResult_PongDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_PongDecodeErrorZ; +/** + * The contents of CResult_UnsignedChannelAnnouncementDecodeErrorZ + */ typedef union LDKCResult_UnsignedChannelAnnouncementDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKUnsignedChannelAnnouncement *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_UnsignedChannelAnnouncementDecodeErrorZPtr; +/** + * A CResult_UnsignedChannelAnnouncementDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::msgs::UnsignedChannelAnnouncement on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ { - union LDKCResult_UnsignedChannelAnnouncementDecodeErrorZPtr contents; + /** + * The contents of this CResult_UnsignedChannelAnnouncementDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ + union LDKCResult_UnsignedChannelAnnouncementDecodeErrorZPtr contents; + /** + * Whether this CResult_UnsignedChannelAnnouncementDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ; +/** + * The contents of CResult_ChannelAnnouncementDecodeErrorZ + */ typedef union LDKCResult_ChannelAnnouncementDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKChannelAnnouncement *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_ChannelAnnouncementDecodeErrorZPtr; +/** + * A CResult_ChannelAnnouncementDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::msgs::ChannelAnnouncement on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_ChannelAnnouncementDecodeErrorZ { + /** + * The contents of this CResult_ChannelAnnouncementDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_ChannelAnnouncementDecodeErrorZPtr contents; + /** + * Whether this CResult_ChannelAnnouncementDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_ChannelAnnouncementDecodeErrorZ; @@ -3178,40 +6133,115 @@ typedef struct LDKCResult_ChannelAnnouncementDecodeErrorZ { */ typedef struct MUST_USE_STRUCT LDKUnsignedChannelUpdate { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeUnsignedChannelUpdate *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKUnsignedChannelUpdate; +/** + * The contents of CResult_UnsignedChannelUpdateDecodeErrorZ + */ typedef union LDKCResult_UnsignedChannelUpdateDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKUnsignedChannelUpdate *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_UnsignedChannelUpdateDecodeErrorZPtr; +/** + * A CResult_UnsignedChannelUpdateDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::msgs::UnsignedChannelUpdate on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ { + /** + * The contents of this CResult_UnsignedChannelUpdateDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_UnsignedChannelUpdateDecodeErrorZPtr contents; + /** + * Whether this CResult_UnsignedChannelUpdateDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_UnsignedChannelUpdateDecodeErrorZ; +/** + * The contents of CResult_ChannelUpdateDecodeErrorZ + */ typedef union LDKCResult_ChannelUpdateDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKChannelUpdate *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_ChannelUpdateDecodeErrorZPtr; +/** + * A CResult_ChannelUpdateDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::msgs::ChannelUpdate on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_ChannelUpdateDecodeErrorZ { + /** + * The contents of this CResult_ChannelUpdateDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_ChannelUpdateDecodeErrorZPtr contents; + /** + * Whether this CResult_ChannelUpdateDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_ChannelUpdateDecodeErrorZ; +/** + * The contents of CResult_ErrorMessageDecodeErrorZ + */ typedef union LDKCResult_ErrorMessageDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKErrorMessage *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_ErrorMessageDecodeErrorZPtr; +/** + * A CResult_ErrorMessageDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::msgs::ErrorMessage on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_ErrorMessageDecodeErrorZ { + /** + * The contents of this CResult_ErrorMessageDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_ErrorMessageDecodeErrorZPtr contents; + /** + * Whether this CResult_ErrorMessageDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_ErrorMessageDecodeErrorZ; @@ -3222,40 +6252,115 @@ typedef struct LDKCResult_ErrorMessageDecodeErrorZ { */ typedef struct MUST_USE_STRUCT LDKUnsignedNodeAnnouncement { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeUnsignedNodeAnnouncement *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKUnsignedNodeAnnouncement; +/** + * The contents of CResult_UnsignedNodeAnnouncementDecodeErrorZ + */ typedef union LDKCResult_UnsignedNodeAnnouncementDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKUnsignedNodeAnnouncement *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_UnsignedNodeAnnouncementDecodeErrorZPtr; +/** + * A CResult_UnsignedNodeAnnouncementDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::msgs::UnsignedNodeAnnouncement on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ { + /** + * The contents of this CResult_UnsignedNodeAnnouncementDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_UnsignedNodeAnnouncementDecodeErrorZPtr contents; + /** + * Whether this CResult_UnsignedNodeAnnouncementDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ; +/** + * The contents of CResult_NodeAnnouncementDecodeErrorZ + */ typedef union LDKCResult_NodeAnnouncementDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKNodeAnnouncement *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_NodeAnnouncementDecodeErrorZPtr; +/** + * A CResult_NodeAnnouncementDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::msgs::NodeAnnouncement on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_NodeAnnouncementDecodeErrorZ { + /** + * The contents of this CResult_NodeAnnouncementDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_NodeAnnouncementDecodeErrorZPtr contents; + /** + * Whether this CResult_NodeAnnouncementDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_NodeAnnouncementDecodeErrorZ; +/** + * The contents of CResult_QueryShortChannelIdsDecodeErrorZ + */ typedef union LDKCResult_QueryShortChannelIdsDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKQueryShortChannelIds *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_QueryShortChannelIdsDecodeErrorZPtr; +/** + * A CResult_QueryShortChannelIdsDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::msgs::QueryShortChannelIds on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_QueryShortChannelIdsDecodeErrorZ { + /** + * The contents of this CResult_QueryShortChannelIdsDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_QueryShortChannelIdsDecodeErrorZPtr contents; + /** + * Whether this CResult_QueryShortChannelIdsDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_QueryShortChannelIdsDecodeErrorZ; @@ -3269,60 +6374,115 @@ typedef struct LDKCResult_QueryShortChannelIdsDecodeErrorZ { */ typedef struct MUST_USE_STRUCT LDKReplyShortChannelIdsEnd { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeReplyShortChannelIdsEnd *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKReplyShortChannelIdsEnd; +/** + * The contents of CResult_ReplyShortChannelIdsEndDecodeErrorZ + */ typedef union LDKCResult_ReplyShortChannelIdsEndDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKReplyShortChannelIdsEnd *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_ReplyShortChannelIdsEndDecodeErrorZPtr; +/** + * A CResult_ReplyShortChannelIdsEndDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::msgs::ReplyShortChannelIdsEnd on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ { + /** + * The contents of this CResult_ReplyShortChannelIdsEndDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_ReplyShortChannelIdsEndDecodeErrorZPtr contents; + /** + * Whether this CResult_ReplyShortChannelIdsEndDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ; +/** + * The contents of CResult_QueryChannelRangeDecodeErrorZ + */ typedef union LDKCResult_QueryChannelRangeDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKQueryChannelRange *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_QueryChannelRangeDecodeErrorZPtr; +/** + * A CResult_QueryChannelRangeDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::msgs::QueryChannelRange on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_QueryChannelRangeDecodeErrorZ { + /** + * The contents of this CResult_QueryChannelRangeDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_QueryChannelRangeDecodeErrorZPtr contents; + /** + * Whether this CResult_QueryChannelRangeDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_QueryChannelRangeDecodeErrorZ; - - /** - * A reply_channel_range message is a reply to a query_channel_range - * message. Multiple reply_channel_range messages can be sent in reply - * to a single query_channel_range message. The query recipient makes a - * best effort to respond based on their local network view which may - * not be a perfect view of the network. The short_channel_ids in the - * reply are encoded. We only support encoding_type=0 uncompressed - * serialization and do not support encoding_type=1 zlib serialization. + * The contents of CResult_ReplyChannelRangeDecodeErrorZ */ -typedef struct MUST_USE_STRUCT LDKReplyChannelRange { +typedef union LDKCResult_ReplyChannelRangeDecodeErrorZPtr { /** - * Nearly everywhere, inner must be non-null, however in places where - * the Rust equivalent takes an Option, it may be set to null to indicate None. + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. */ - LDKnativeReplyChannelRange *inner; - bool is_owned; -} LDKReplyChannelRange; - -typedef union LDKCResult_ReplyChannelRangeDecodeErrorZPtr { struct LDKReplyChannelRange *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_ReplyChannelRangeDecodeErrorZPtr; +/** + * A CResult_ReplyChannelRangeDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::msgs::ReplyChannelRange on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_ReplyChannelRangeDecodeErrorZ { + /** + * The contents of this CResult_ReplyChannelRangeDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_ReplyChannelRangeDecodeErrorZPtr contents; + /** + * Whether this CResult_ReplyChannelRangeDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_ReplyChannelRangeDecodeErrorZ; @@ -3335,20 +6495,49 @@ typedef struct LDKCResult_ReplyChannelRangeDecodeErrorZ { */ typedef struct MUST_USE_STRUCT LDKGossipTimestampFilter { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeGossipTimestampFilter *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKGossipTimestampFilter; +/** + * The contents of CResult_GossipTimestampFilterDecodeErrorZ + */ typedef union LDKCResult_GossipTimestampFilterDecodeErrorZPtr { + /** + * A pointer to the contents in the success state. + * Reading from this pointer when `result_ok` is not set is undefined. + */ struct LDKGossipTimestampFilter *result; + /** + * A pointer to the contents in the error state. + * Reading from this pointer when `result_ok` is set is undefined. + */ struct LDKDecodeError *err; } LDKCResult_GossipTimestampFilterDecodeErrorZPtr; +/** + * A CResult_GossipTimestampFilterDecodeErrorZ represents the result of a fallible operation, + * containing a crate::ln::msgs::GossipTimestampFilter on success and a crate::ln::msgs::DecodeError on failure. + * `result_ok` indicates the overall state, and the contents are provided via `contents`. + */ typedef struct LDKCResult_GossipTimestampFilterDecodeErrorZ { + /** + * The contents of this CResult_GossipTimestampFilterDecodeErrorZ, accessible via either + * `err` or `result` depending on the state of `result_ok`. + */ union LDKCResult_GossipTimestampFilterDecodeErrorZPtr contents; + /** + * Whether this CResult_GossipTimestampFilterDecodeErrorZ represents a success state. + */ bool result_ok; } LDKCResult_GossipTimestampFilterDecodeErrorZ; @@ -3356,12 +6545,20 @@ typedef struct LDKCResult_GossipTimestampFilterDecodeErrorZ { * A trait indicating an object may generate message send events */ typedef struct LDKMessageSendEventsProvider { + /** + * An opaque pointer which is passed to your function implementations as an argument. + * This has no meaning in the LDK, and can be NULL or any other value. + */ void *this_arg; /** * Gets the list of pending events which were generated by previous actions, clearing the list * in the process. */ struct LDKCVec_MessageSendEventZ (*get_and_clear_pending_msg_events)(const void *this_arg); + /** + * Frees any resources associated with this object given its this_arg pointer. + * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed. + */ void (*free)(void *this_arg); } LDKMessageSendEventsProvider; @@ -3369,12 +6566,20 @@ typedef struct LDKMessageSendEventsProvider { * A trait indicating an object may generate events */ typedef struct LDKEventsProvider { + /** + * An opaque pointer which is passed to your function implementations as an argument. + * This has no meaning in the LDK, and can be NULL or any other value. + */ void *this_arg; /** * Gets the list of pending events which were generated by previous actions, clearing the list * in the process. */ struct LDKCVec_EventZ (*get_and_clear_pending_events)(const void *this_arg); + /** + * Frees any resources associated with this object given its this_arg pointer. + * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed. + */ void (*free)(void *this_arg); } LDKEventsProvider; @@ -3387,10 +6592,16 @@ typedef struct LDKEventsProvider { */ typedef struct MUST_USE_STRUCT LDKChannelHandshakeConfig { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeChannelHandshakeConfig *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKChannelHandshakeConfig; @@ -3411,10 +6622,16 @@ typedef struct MUST_USE_STRUCT LDKChannelHandshakeConfig { */ typedef struct MUST_USE_STRUCT LDKChannelHandshakeLimits { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeChannelHandshakeLimits *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKChannelHandshakeLimits; @@ -3428,10 +6645,16 @@ typedef struct MUST_USE_STRUCT LDKChannelHandshakeLimits { */ typedef struct MUST_USE_STRUCT LDKUserConfig { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeUserConfig *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKUserConfig; @@ -3440,6 +6663,10 @@ typedef struct MUST_USE_STRUCT LDKUserConfig { * UTXOs. */ typedef struct LDKAccess { + /** + * An opaque pointer which is passed to your function implementations as an argument. + * This has no meaning in the LDK, and can be NULL or any other value. + */ void *this_arg; /** * Returns the transaction output of a funding transaction encoded by [`short_channel_id`]. @@ -3449,6 +6676,10 @@ typedef struct LDKAccess { * [`short_channel_id`]: https://github.com/lightningnetwork/lightning-rfc/blob/master/07-routing-gossip.md#definition-of-short_channel_id */ struct LDKCResult_TxOutAccessErrorZ (*get_utxo)(const void *this_arg, const uint8_t (*genesis_hash)[32], uint64_t short_channel_id); + /** + * Frees any resources associated with this object given its this_arg pointer. + * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed. + */ void (*free)(void *this_arg); } LDKAccess; @@ -3459,6 +6690,10 @@ typedef struct LDKAccess { * Useful when needing to replay chain data upon startup or as new chain events occur. */ typedef struct LDKListen { + /** + * An opaque pointer which is passed to your function implementations as an argument. + * This has no meaning in the LDK, and can be NULL or any other value. + */ void *this_arg; /** * Notifies the listener that a block was added at the given height. @@ -3468,9 +6703,43 @@ typedef struct LDKListen { * Notifies the listener that a block was removed at the given height. */ void (*block_disconnected)(const void *this_arg, const uint8_t (*header)[80], uint32_t height); + /** + * Frees any resources associated with this object given its this_arg pointer. + * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed. + */ void (*free)(void *this_arg); } LDKListen; + + +/** + * A transaction output watched by a [`ChannelMonitor`] for spends on-chain. + * + * Used to convey to a [`Filter`] such an output with a given spending condition. Any transaction + * spending the output must be given to [`ChannelMonitor::block_connected`] either directly or via + * the return value of [`Filter::register_output`]. + * + * If `block_hash` is `Some`, this indicates the output was created in the corresponding block and + * may have been spent there. See [`Filter::register_output`] for details. + * + * [`ChannelMonitor`]: channelmonitor::ChannelMonitor + * [`ChannelMonitor::block_connected`]: channelmonitor::ChannelMonitor::block_connected + */ +typedef struct MUST_USE_STRUCT LDKWatchedOutput { + /** + * A pointer to the opaque Rust object. + * Nearly everywhere, inner must be non-null, however in places where + * the Rust equivalent takes an Option, it may be set to null to indicate None. + */ + LDKnativeWatchedOutput *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ + bool is_owned; +} LDKWatchedOutput; + /** * The `Filter` trait defines behavior for indicating chain activity of interest pertaining to * channels. @@ -3486,15 +6755,18 @@ typedef struct LDKListen { * * Note that use as part of a [`Watch`] implementation involves reentrancy. Therefore, the `Filter` * should not block on I/O. Implementations should instead queue the newly monitored data to be - * processed later. Then, in order to block until the data has been processed, any `Watch` + * processed later. Then, in order to block until the data has been processed, any [`Watch`] * invocation that has called the `Filter` must return [`TemporaryFailure`]. * - * [`Watch`]: trait.Watch.html - * [`TemporaryFailure`]: channelmonitor/enum.ChannelMonitorUpdateErr.html#variant.TemporaryFailure + * [`TemporaryFailure`]: channelmonitor::ChannelMonitorUpdateErr::TemporaryFailure * [BIP 157]: https://github.com/bitcoin/bips/blob/master/bip-0157.mediawiki * [BIP 158]: https://github.com/bitcoin/bips/blob/master/bip-0158.mediawiki */ typedef struct LDKFilter { + /** + * An opaque pointer which is passed to your function implementations as an argument. + * This has no meaning in the LDK, and can be NULL or any other value. + */ void *this_arg; /** * Registers interest in a transaction with `txid` and having an output with `script_pubkey` as @@ -3502,10 +6774,21 @@ typedef struct LDKFilter { */ void (*register_tx)(const void *this_arg, const uint8_t (*txid)[32], struct LDKu8slice script_pubkey); /** - * Registers interest in spends of a transaction output identified by `outpoint` having - * `script_pubkey` as the spending condition. + * Registers interest in spends of a transaction output. + * + * Optionally, when `output.block_hash` is set, should return any transaction spending the + * output that is found in the corresponding block along with its index. + * + * This return value is useful for Electrum clients in order to supply in-block descendant + * transactions which otherwise were not included. This is not necessary for other clients if + * such descendant transactions were already included (e.g., when a BIP 157 client provides the + * full block). + */ + struct LDKCOption_C2Tuple_usizeTransactionZZ (*register_output)(const void *this_arg, struct LDKWatchedOutput output); + /** + * Frees any resources associated with this object given its this_arg pointer. + * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed. */ - void (*register_output)(const void *this_arg, const struct LDKOutPoint *NONNULL_PTR outpoint, struct LDKu8slice script_pubkey); void (*free)(void *this_arg); } LDKFilter; @@ -3523,6 +6806,10 @@ typedef struct LDKFilter { * kept up-to-date. */ typedef struct LDKPersist { + /** + * An opaque pointer which is passed to your function implementations as an argument. + * This has no meaning in the LDK, and can be NULL or any other value. + */ void *this_arg; /** * Persist a new channel's data. The data can be stored any way you want, but @@ -3531,11 +6818,8 @@ typedef struct LDKPersist { * stored channel data). Note that you **must** persist every new monitor to * disk. See the `Persist` trait documentation for more details. * - * See [`ChannelMonitor::serialize_for_disk`] for writing out a `ChannelMonitor`, + * See [`ChannelMonitor::write`] for writing out a `ChannelMonitor`, * and [`ChannelMonitorUpdateErr`] for requirements when returning errors. - * - * [`ChannelMonitor::serialize_for_disk`]: struct.ChannelMonitor.html#method.serialize_for_disk - * [`ChannelMonitorUpdateErr`]: enum.ChannelMonitorUpdateErr.html */ struct LDKCResult_NoneChannelMonitorUpdateErrZ (*persist_new_channel)(const void *this_arg, struct LDKOutPoint id, const struct LDKChannelMonitor *NONNULL_PTR data); /** @@ -3558,16 +6842,15 @@ typedef struct LDKPersist { * them in batches. The size of each monitor grows `O(number of state updates)` * whereas updates are small and `O(1)`. * - * See [`ChannelMonitor::serialize_for_disk`] for writing out a `ChannelMonitor`, + * See [`ChannelMonitor::write`] for writing out a `ChannelMonitor`, * [`ChannelMonitorUpdate::write`] for writing out an update, and * [`ChannelMonitorUpdateErr`] for requirements when returning errors. - * - * [`ChannelMonitor::update_monitor`]: struct.ChannelMonitor.html#impl-1 - * [`ChannelMonitor::serialize_for_disk`]: struct.ChannelMonitor.html#method.serialize_for_disk - * [`ChannelMonitorUpdate::write`]: struct.ChannelMonitorUpdate.html#method.write - * [`ChannelMonitorUpdateErr`]: enum.ChannelMonitorUpdateErr.html */ 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); + /** + * Frees any resources associated with this object given its this_arg pointer. + * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed. + */ void (*free)(void *this_arg); } LDKPersist; @@ -3581,16 +6864,21 @@ typedef struct LDKPersist { * or used independently to monitor channels remotely. See the [module-level documentation] for * details. * - * [`chain::Watch`]: ../trait.Watch.html - * [`ChannelManager`]: ../../ln/channelmanager/struct.ChannelManager.html - * [module-level documentation]: index.html + * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager + * [module-level documentation]: crate::chain::chainmonitor */ typedef struct MUST_USE_STRUCT LDKChainMonitor { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeChainMonitor *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKChainMonitor; @@ -3607,10 +6895,16 @@ typedef struct MUST_USE_STRUCT LDKChainMonitor { */ typedef struct MUST_USE_STRUCT LDKKeysManager { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeKeysManager *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKKeysManager; @@ -3625,14 +6919,26 @@ typedef struct MUST_USE_STRUCT LDKKeysManager { */ typedef struct MUST_USE_STRUCT LDKChainParameters { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeChainParameters *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKChainParameters; +/** + * A 3-byte byte array. + */ typedef struct LDKThreeBytes { + /** + * The three bytes + */ uint8_t data[3]; } LDKThreeBytes; @@ -3643,6 +6949,10 @@ typedef struct LDKThreeBytes { * they MUST NOT be called in parallel when the two calls have the same their_node_id. */ typedef struct LDKChannelMessageHandler { + /** + * An opaque pointer which is passed to your function implementations as an argument. + * This has no meaning in the LDK, and can be NULL or any other value. + */ void *this_arg; /** * Handle an incoming open_channel message from the given peer. @@ -3719,11 +7029,22 @@ typedef struct LDKChannelMessageHandler { * Handle an incoming channel_reestablish message from the given peer. */ void (*handle_channel_reestablish)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKChannelReestablish *NONNULL_PTR msg); + /** + * Handle an incoming channel update from the given peer. + */ + void (*handle_channel_update)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKChannelUpdate *NONNULL_PTR msg); /** * Handle an incoming error message from the given peer. */ void (*handle_error)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKErrorMessage *NONNULL_PTR msg); + /** + * Implementation of MessageSendEventsProvider for this object. + */ struct LDKMessageSendEventsProvider MessageSendEventsProvider; + /** + * Frees any resources associated with this object given its this_arg pointer. + * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed. + */ void (*free)(void *this_arg); } LDKChannelMessageHandler; @@ -3758,10 +7079,16 @@ typedef struct LDKChannelMessageHandler { */ typedef struct MUST_USE_STRUCT LDKChannelManagerReadArgs { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeChannelManagerReadArgs *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKChannelManagerReadArgs; @@ -3775,10 +7102,16 @@ typedef struct MUST_USE_STRUCT LDKChannelManagerReadArgs { */ typedef struct MUST_USE_STRUCT LDKDataLossProtect { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeDataLossProtect *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKDataLossProtect; @@ -3792,6 +7125,10 @@ typedef struct MUST_USE_STRUCT LDKDataLossProtect { * repeated disk I/O for queries accessing different parts of the network graph. */ typedef struct LDKRoutingMessageHandler { + /** + * An opaque pointer which is passed to your function implementations as an argument. + * This has no meaning in the LDK, and can be NULL or any other value. + */ void *this_arg; /** * Handle an incoming node_announcement message, returning true if it should be forwarded on, @@ -3854,7 +7191,14 @@ typedef struct LDKRoutingMessageHandler { * list of short_channel_ids. */ struct LDKCResult_NoneLightningErrorZ (*handle_query_short_channel_ids)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKQueryShortChannelIds msg); + /** + * Implementation of MessageSendEventsProvider for this object. + */ struct LDKMessageSendEventsProvider MessageSendEventsProvider; + /** + * Frees any resources associated with this object given its this_arg pointer. + * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed. + */ void (*free)(void *this_arg); } LDKRoutingMessageHandler; @@ -3866,10 +7210,16 @@ typedef struct LDKRoutingMessageHandler { */ typedef struct MUST_USE_STRUCT LDKIgnoringMessageHandler { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeIgnoringMessageHandler *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKIgnoringMessageHandler; @@ -3881,10 +7231,16 @@ typedef struct MUST_USE_STRUCT LDKIgnoringMessageHandler { */ typedef struct MUST_USE_STRUCT LDKErroringMessageHandler { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeErroringMessageHandler *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKErroringMessageHandler; @@ -3895,10 +7251,16 @@ typedef struct MUST_USE_STRUCT LDKErroringMessageHandler { */ typedef struct MUST_USE_STRUCT LDKMessageHandler { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeMessageHandler *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKMessageHandler; @@ -3916,6 +7278,10 @@ typedef struct MUST_USE_STRUCT LDKMessageHandler { * PeerManager::socket_disconnected(). */ typedef struct LDKSocketDescriptor { + /** + * An opaque pointer which is passed to your function implementations as an argument. + * This has no meaning in the LDK, and can be NULL or any other value. + */ void *this_arg; /** * Attempts to send some data from the given slice to the peer. @@ -3942,9 +7308,25 @@ typedef struct LDKSocketDescriptor { * socket_disconnected but prior to socket_disconnected returning. */ void (*disconnect_socket)(void *this_arg); + /** + * Checks if two objects are equal given this object's this_arg pointer and another object. + */ bool (*eq)(const void *this_arg, const struct LDKSocketDescriptor *NONNULL_PTR other_arg); + /** + * Calculate a succinct non-cryptographic hash for an object given its this_arg pointer. + * This is used, for example, for inclusion of this object in a hash map. + */ uint64_t (*hash)(const void *this_arg); + /** + * Creates a copy of the object pointed to by this_arg, for a copy of this SocketDescriptor. + * Note that the ultimate copy of the SocketDescriptor will have all function pointers the same as the original. + * May be NULL if no action needs to be taken, the this_arg pointer will be copied into the new SocketDescriptor. + */ void *(*clone)(const void *this_arg); + /** + * Frees any resources associated with this object given its this_arg pointer. + * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed. + */ void (*free)(void *this_arg); } LDKSocketDescriptor; @@ -3962,10 +7344,16 @@ typedef struct LDKSocketDescriptor { */ typedef struct MUST_USE_STRUCT LDKPeerManager { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativePeerManager *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKPeerManager; @@ -3980,10 +7368,16 @@ typedef struct MUST_USE_STRUCT LDKPeerManager { */ typedef struct MUST_USE_STRUCT LDKDirectedChannelTransactionParameters { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeDirectedChannelTransactionParameters *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKDirectedChannelTransactionParameters; @@ -3996,10 +7390,16 @@ typedef struct MUST_USE_STRUCT LDKDirectedChannelTransactionParameters { */ typedef struct MUST_USE_STRUCT LDKLockedNetworkGraph { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeLockedNetworkGraph *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKLockedNetworkGraph; @@ -4014,10 +7414,16 @@ typedef struct MUST_USE_STRUCT LDKLockedNetworkGraph { */ typedef struct MUST_USE_STRUCT LDKNetGraphMsgHandler { /** + * A pointer to the opaque Rust object. * Nearly everywhere, inner must be non-null, however in places where * the Rust equivalent takes an Option, it may be set to null to indicate None. */ LDKnativeNetGraphMsgHandler *inner; + /** + * Indicates that this is the only struct which contains the same pointer. + * Rust functions which take ownership of an object provided via an argument require + * this to be true and invalidate the object pointed to by inner. + */ bool is_owned; } LDKNetGraphMsgHandler; @@ -4027,738 +7433,2022 @@ extern const uint64_t MIN_RELAY_FEE_SAT_PER_1000_WEIGHT; extern const uint64_t CLOSED_CHANNEL_UPDATE_ID; +extern const uint16_t BREAKDOWN_TIMEOUT; + +extern const uint16_t MIN_CLTV_EXPIRY_DELTA; + extern const uintptr_t REVOKEABLE_REDEEMSCRIPT_MAX_LENGTH; +/** + * Frees the data buffer, if data_is_owned is set and datalen > 0. + */ void Transaction_free(struct LDKTransaction _res); +/** + * Frees the data pointed to by script_pubkey. + */ void TxOut_free(struct LDKTxOut _res); +/** + * Creates a new TxOut which has the same data as `orig` but with a new script buffer. + */ struct LDKTxOut TxOut_clone(const struct LDKTxOut *NONNULL_PTR orig); +/** + * Creates a new CResult_SecretKeyErrorZ in the success state. + */ struct LDKCResult_SecretKeyErrorZ CResult_SecretKeyErrorZ_ok(struct LDKSecretKey o); +/** + * Creates a new CResult_SecretKeyErrorZ in the error state. + */ struct LDKCResult_SecretKeyErrorZ CResult_SecretKeyErrorZ_err(enum LDKSecp256k1Error e); +/** + * Frees any resources used by the CResult_SecretKeyErrorZ. + */ void CResult_SecretKeyErrorZ_free(struct LDKCResult_SecretKeyErrorZ _res); +/** + * Creates a new CResult_PublicKeyErrorZ in the success state. + */ struct LDKCResult_PublicKeyErrorZ CResult_PublicKeyErrorZ_ok(struct LDKPublicKey o); +/** + * Creates a new CResult_PublicKeyErrorZ in the error state. + */ struct LDKCResult_PublicKeyErrorZ CResult_PublicKeyErrorZ_err(enum LDKSecp256k1Error e); +/** + * Frees any resources used by the CResult_PublicKeyErrorZ. + */ void CResult_PublicKeyErrorZ_free(struct LDKCResult_PublicKeyErrorZ _res); +/** + * Creates a new CResult_TxCreationKeysDecodeErrorZ in the success state. + */ struct LDKCResult_TxCreationKeysDecodeErrorZ CResult_TxCreationKeysDecodeErrorZ_ok(struct LDKTxCreationKeys o); +/** + * Creates a new CResult_TxCreationKeysDecodeErrorZ in the error state. + */ struct LDKCResult_TxCreationKeysDecodeErrorZ CResult_TxCreationKeysDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_TxCreationKeysDecodeErrorZ. + */ void CResult_TxCreationKeysDecodeErrorZ_free(struct LDKCResult_TxCreationKeysDecodeErrorZ _res); +/** + * Creates a new CResult_TxCreationKeysDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_TxCreationKeysDecodeErrorZ CResult_TxCreationKeysDecodeErrorZ_clone(const struct LDKCResult_TxCreationKeysDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_ChannelPublicKeysDecodeErrorZ in the success state. + */ struct LDKCResult_ChannelPublicKeysDecodeErrorZ CResult_ChannelPublicKeysDecodeErrorZ_ok(struct LDKChannelPublicKeys o); +/** + * Creates a new CResult_ChannelPublicKeysDecodeErrorZ in the error state. + */ struct LDKCResult_ChannelPublicKeysDecodeErrorZ CResult_ChannelPublicKeysDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_ChannelPublicKeysDecodeErrorZ. + */ void CResult_ChannelPublicKeysDecodeErrorZ_free(struct LDKCResult_ChannelPublicKeysDecodeErrorZ _res); +/** + * Creates a new CResult_ChannelPublicKeysDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_ChannelPublicKeysDecodeErrorZ CResult_ChannelPublicKeysDecodeErrorZ_clone(const struct LDKCResult_ChannelPublicKeysDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_TxCreationKeysErrorZ in the success state. + */ struct LDKCResult_TxCreationKeysErrorZ CResult_TxCreationKeysErrorZ_ok(struct LDKTxCreationKeys o); +/** + * Creates a new CResult_TxCreationKeysErrorZ in the error state. + */ struct LDKCResult_TxCreationKeysErrorZ CResult_TxCreationKeysErrorZ_err(enum LDKSecp256k1Error e); +/** + * Frees any resources used by the CResult_TxCreationKeysErrorZ. + */ void CResult_TxCreationKeysErrorZ_free(struct LDKCResult_TxCreationKeysErrorZ _res); +/** + * Constructs a new COption_u32Z containing a u32 + */ +struct LDKCOption_u32Z COption_u32Z_some(uint32_t o); + +/** + * Constructs a new COption_u32Z containing nothing + */ +struct LDKCOption_u32Z COption_u32Z_none(void); + +/** + * Frees any resources associated with the u32, if we are in the Some state + */ +void COption_u32Z_free(struct LDKCOption_u32Z _res); + +/** + * Creates a new COption_u32Z which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ +struct LDKCOption_u32Z COption_u32Z_clone(const struct LDKCOption_u32Z *NONNULL_PTR orig); + +/** + * Creates a new CResult_HTLCOutputInCommitmentDecodeErrorZ in the success state. + */ struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ CResult_HTLCOutputInCommitmentDecodeErrorZ_ok(struct LDKHTLCOutputInCommitment o); +/** + * Creates a new CResult_HTLCOutputInCommitmentDecodeErrorZ in the error state. + */ struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ CResult_HTLCOutputInCommitmentDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_HTLCOutputInCommitmentDecodeErrorZ. + */ void CResult_HTLCOutputInCommitmentDecodeErrorZ_free(struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ _res); +/** + * Creates a new CResult_HTLCOutputInCommitmentDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ CResult_HTLCOutputInCommitmentDecodeErrorZ_clone(const struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_CounterpartyChannelTransactionParametersDecodeErrorZ in the success state. + */ struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ CResult_CounterpartyChannelTransactionParametersDecodeErrorZ_ok(struct LDKCounterpartyChannelTransactionParameters o); +/** + * Creates a new CResult_CounterpartyChannelTransactionParametersDecodeErrorZ in the error state. + */ struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ CResult_CounterpartyChannelTransactionParametersDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_CounterpartyChannelTransactionParametersDecodeErrorZ. + */ void CResult_CounterpartyChannelTransactionParametersDecodeErrorZ_free(struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ _res); +/** + * Creates a new CResult_CounterpartyChannelTransactionParametersDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ CResult_CounterpartyChannelTransactionParametersDecodeErrorZ_clone(const struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_ChannelTransactionParametersDecodeErrorZ in the success state. + */ struct LDKCResult_ChannelTransactionParametersDecodeErrorZ CResult_ChannelTransactionParametersDecodeErrorZ_ok(struct LDKChannelTransactionParameters o); +/** + * Creates a new CResult_ChannelTransactionParametersDecodeErrorZ in the error state. + */ struct LDKCResult_ChannelTransactionParametersDecodeErrorZ CResult_ChannelTransactionParametersDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_ChannelTransactionParametersDecodeErrorZ. + */ void CResult_ChannelTransactionParametersDecodeErrorZ_free(struct LDKCResult_ChannelTransactionParametersDecodeErrorZ _res); +/** + * Creates a new CResult_ChannelTransactionParametersDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_ChannelTransactionParametersDecodeErrorZ CResult_ChannelTransactionParametersDecodeErrorZ_clone(const struct LDKCResult_ChannelTransactionParametersDecodeErrorZ *NONNULL_PTR orig); +/** + * Frees the buffer pointed to by `data` if `datalen` is non-0. + */ void CVec_SignatureZ_free(struct LDKCVec_SignatureZ _res); +/** + * Creates a new CResult_HolderCommitmentTransactionDecodeErrorZ in the success state. + */ struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ CResult_HolderCommitmentTransactionDecodeErrorZ_ok(struct LDKHolderCommitmentTransaction o); +/** + * Creates a new CResult_HolderCommitmentTransactionDecodeErrorZ in the error state. + */ struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ CResult_HolderCommitmentTransactionDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_HolderCommitmentTransactionDecodeErrorZ. + */ void CResult_HolderCommitmentTransactionDecodeErrorZ_free(struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ _res); +/** + * Creates a new CResult_HolderCommitmentTransactionDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ CResult_HolderCommitmentTransactionDecodeErrorZ_clone(const struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_BuiltCommitmentTransactionDecodeErrorZ in the success state. + */ struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ CResult_BuiltCommitmentTransactionDecodeErrorZ_ok(struct LDKBuiltCommitmentTransaction o); +/** + * Creates a new CResult_BuiltCommitmentTransactionDecodeErrorZ in the error state. + */ struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ CResult_BuiltCommitmentTransactionDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_BuiltCommitmentTransactionDecodeErrorZ. + */ void CResult_BuiltCommitmentTransactionDecodeErrorZ_free(struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ _res); +/** + * Creates a new CResult_BuiltCommitmentTransactionDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ CResult_BuiltCommitmentTransactionDecodeErrorZ_clone(const struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_CommitmentTransactionDecodeErrorZ in the success state. + */ struct LDKCResult_CommitmentTransactionDecodeErrorZ CResult_CommitmentTransactionDecodeErrorZ_ok(struct LDKCommitmentTransaction o); +/** + * Creates a new CResult_CommitmentTransactionDecodeErrorZ in the error state. + */ struct LDKCResult_CommitmentTransactionDecodeErrorZ CResult_CommitmentTransactionDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_CommitmentTransactionDecodeErrorZ. + */ void CResult_CommitmentTransactionDecodeErrorZ_free(struct LDKCResult_CommitmentTransactionDecodeErrorZ _res); +/** + * Creates a new CResult_CommitmentTransactionDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_CommitmentTransactionDecodeErrorZ CResult_CommitmentTransactionDecodeErrorZ_clone(const struct LDKCResult_CommitmentTransactionDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_TrustedCommitmentTransactionNoneZ in the success state. + */ struct LDKCResult_TrustedCommitmentTransactionNoneZ CResult_TrustedCommitmentTransactionNoneZ_ok(struct LDKTrustedCommitmentTransaction o); +/** + * Creates a new CResult_TrustedCommitmentTransactionNoneZ in the error state. + */ struct LDKCResult_TrustedCommitmentTransactionNoneZ CResult_TrustedCommitmentTransactionNoneZ_err(void); +/** + * Frees any resources used by the CResult_TrustedCommitmentTransactionNoneZ. + */ void CResult_TrustedCommitmentTransactionNoneZ_free(struct LDKCResult_TrustedCommitmentTransactionNoneZ _res); +/** + * Creates a new CResult_CVec_SignatureZNoneZ in the success state. + */ struct LDKCResult_CVec_SignatureZNoneZ CResult_CVec_SignatureZNoneZ_ok(struct LDKCVec_SignatureZ o); +/** + * Creates a new CResult_CVec_SignatureZNoneZ in the error state. + */ struct LDKCResult_CVec_SignatureZNoneZ CResult_CVec_SignatureZNoneZ_err(void); +/** + * Frees any resources used by the CResult_CVec_SignatureZNoneZ. + */ void CResult_CVec_SignatureZNoneZ_free(struct LDKCResult_CVec_SignatureZNoneZ _res); +/** + * Creates a new CResult_CVec_SignatureZNoneZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_CVec_SignatureZNoneZ CResult_CVec_SignatureZNoneZ_clone(const struct LDKCResult_CVec_SignatureZNoneZ *NONNULL_PTR orig); +/** + * Frees the buffer pointed to by `data` if `datalen` is non-0. + */ void CVec_MessageSendEventZ_free(struct LDKCVec_MessageSendEventZ _res); +/** + * Creates a new CResult_boolLightningErrorZ in the success state. + */ struct LDKCResult_boolLightningErrorZ CResult_boolLightningErrorZ_ok(bool o); +/** + * Creates a new CResult_boolLightningErrorZ in the error state. + */ struct LDKCResult_boolLightningErrorZ CResult_boolLightningErrorZ_err(struct LDKLightningError e); +/** + * Frees any resources used by the CResult_boolLightningErrorZ. + */ void CResult_boolLightningErrorZ_free(struct LDKCResult_boolLightningErrorZ _res); +/** + * Creates a new CResult_boolLightningErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_boolLightningErrorZ CResult_boolLightningErrorZ_clone(const struct LDKCResult_boolLightningErrorZ *NONNULL_PTR orig); +/** + * Creates a new tuple which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ_clone(const struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ *NONNULL_PTR orig); +/** + * Creates a new C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ from the contained elements. + */ struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ_new(struct LDKChannelAnnouncement a, struct LDKChannelUpdate b, struct LDKChannelUpdate c); +/** + * Frees any resources used by the C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ. + */ void C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ_free(struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ _res); +/** + * Frees the buffer pointed to by `data` if `datalen` is non-0. + */ void CVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ_free(struct LDKCVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ _res); +/** + * Frees the buffer pointed to by `data` if `datalen` is non-0. + */ void CVec_NodeAnnouncementZ_free(struct LDKCVec_NodeAnnouncementZ _res); +/** + * Creates a new CResult_NoneLightningErrorZ in the success state. + */ struct LDKCResult_NoneLightningErrorZ CResult_NoneLightningErrorZ_ok(void); +/** + * Creates a new CResult_NoneLightningErrorZ in the error state. + */ struct LDKCResult_NoneLightningErrorZ CResult_NoneLightningErrorZ_err(struct LDKLightningError e); +/** + * Frees any resources used by the CResult_NoneLightningErrorZ. + */ void CResult_NoneLightningErrorZ_free(struct LDKCResult_NoneLightningErrorZ _res); +/** + * Creates a new CResult_NoneLightningErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_NoneLightningErrorZ CResult_NoneLightningErrorZ_clone(const struct LDKCResult_NoneLightningErrorZ *NONNULL_PTR orig); +/** + * Frees the buffer pointed to by `data` if `datalen` is non-0. + */ void CVec_PublicKeyZ_free(struct LDKCVec_PublicKeyZ _res); +/** + * Frees the buffer pointed to by `data` if `datalen` is non-0. + */ void CVec_u8Z_free(struct LDKCVec_u8Z _res); +/** + * Creates a new CResult_CVec_u8ZPeerHandleErrorZ in the success state. + */ struct LDKCResult_CVec_u8ZPeerHandleErrorZ CResult_CVec_u8ZPeerHandleErrorZ_ok(struct LDKCVec_u8Z o); +/** + * Creates a new CResult_CVec_u8ZPeerHandleErrorZ in the error state. + */ struct LDKCResult_CVec_u8ZPeerHandleErrorZ CResult_CVec_u8ZPeerHandleErrorZ_err(struct LDKPeerHandleError e); +/** + * Frees any resources used by the CResult_CVec_u8ZPeerHandleErrorZ. + */ void CResult_CVec_u8ZPeerHandleErrorZ_free(struct LDKCResult_CVec_u8ZPeerHandleErrorZ _res); +/** + * Creates a new CResult_CVec_u8ZPeerHandleErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_CVec_u8ZPeerHandleErrorZ CResult_CVec_u8ZPeerHandleErrorZ_clone(const struct LDKCResult_CVec_u8ZPeerHandleErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_NonePeerHandleErrorZ in the success state. + */ struct LDKCResult_NonePeerHandleErrorZ CResult_NonePeerHandleErrorZ_ok(void); +/** + * Creates a new CResult_NonePeerHandleErrorZ in the error state. + */ struct LDKCResult_NonePeerHandleErrorZ CResult_NonePeerHandleErrorZ_err(struct LDKPeerHandleError e); +/** + * Frees any resources used by the CResult_NonePeerHandleErrorZ. + */ void CResult_NonePeerHandleErrorZ_free(struct LDKCResult_NonePeerHandleErrorZ _res); +/** + * Creates a new CResult_NonePeerHandleErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_NonePeerHandleErrorZ CResult_NonePeerHandleErrorZ_clone(const struct LDKCResult_NonePeerHandleErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_boolPeerHandleErrorZ in the success state. + */ struct LDKCResult_boolPeerHandleErrorZ CResult_boolPeerHandleErrorZ_ok(bool o); +/** + * Creates a new CResult_boolPeerHandleErrorZ in the error state. + */ struct LDKCResult_boolPeerHandleErrorZ CResult_boolPeerHandleErrorZ_err(struct LDKPeerHandleError e); +/** + * Frees any resources used by the CResult_boolPeerHandleErrorZ. + */ void CResult_boolPeerHandleErrorZ_free(struct LDKCResult_boolPeerHandleErrorZ _res); +/** + * Creates a new CResult_boolPeerHandleErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_boolPeerHandleErrorZ CResult_boolPeerHandleErrorZ_clone(const struct LDKCResult_boolPeerHandleErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_InitFeaturesDecodeErrorZ in the success state. + */ struct LDKCResult_InitFeaturesDecodeErrorZ CResult_InitFeaturesDecodeErrorZ_ok(struct LDKInitFeatures o); +/** + * Creates a new CResult_InitFeaturesDecodeErrorZ in the error state. + */ struct LDKCResult_InitFeaturesDecodeErrorZ CResult_InitFeaturesDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_InitFeaturesDecodeErrorZ. + */ void CResult_InitFeaturesDecodeErrorZ_free(struct LDKCResult_InitFeaturesDecodeErrorZ _res); +/** + * Creates a new CResult_NodeFeaturesDecodeErrorZ in the success state. + */ struct LDKCResult_NodeFeaturesDecodeErrorZ CResult_NodeFeaturesDecodeErrorZ_ok(struct LDKNodeFeatures o); +/** + * Creates a new CResult_NodeFeaturesDecodeErrorZ in the error state. + */ struct LDKCResult_NodeFeaturesDecodeErrorZ CResult_NodeFeaturesDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_NodeFeaturesDecodeErrorZ. + */ void CResult_NodeFeaturesDecodeErrorZ_free(struct LDKCResult_NodeFeaturesDecodeErrorZ _res); +/** + * Creates a new CResult_ChannelFeaturesDecodeErrorZ in the success state. + */ struct LDKCResult_ChannelFeaturesDecodeErrorZ CResult_ChannelFeaturesDecodeErrorZ_ok(struct LDKChannelFeatures o); +/** + * Creates a new CResult_ChannelFeaturesDecodeErrorZ in the error state. + */ struct LDKCResult_ChannelFeaturesDecodeErrorZ CResult_ChannelFeaturesDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_ChannelFeaturesDecodeErrorZ. + */ void CResult_ChannelFeaturesDecodeErrorZ_free(struct LDKCResult_ChannelFeaturesDecodeErrorZ _res); +/** + * Creates a new CResult_InvoiceFeaturesDecodeErrorZ in the success state. + */ +struct LDKCResult_InvoiceFeaturesDecodeErrorZ CResult_InvoiceFeaturesDecodeErrorZ_ok(struct LDKInvoiceFeatures o); + +/** + * Creates a new CResult_InvoiceFeaturesDecodeErrorZ in the error state. + */ +struct LDKCResult_InvoiceFeaturesDecodeErrorZ CResult_InvoiceFeaturesDecodeErrorZ_err(struct LDKDecodeError e); + +/** + * Frees any resources used by the CResult_InvoiceFeaturesDecodeErrorZ. + */ +void CResult_InvoiceFeaturesDecodeErrorZ_free(struct LDKCResult_InvoiceFeaturesDecodeErrorZ _res); + +/** + * Creates a new CResult_ChannelConfigDecodeErrorZ in the success state. + */ struct LDKCResult_ChannelConfigDecodeErrorZ CResult_ChannelConfigDecodeErrorZ_ok(struct LDKChannelConfig o); +/** + * Creates a new CResult_ChannelConfigDecodeErrorZ in the error state. + */ struct LDKCResult_ChannelConfigDecodeErrorZ CResult_ChannelConfigDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_ChannelConfigDecodeErrorZ. + */ void CResult_ChannelConfigDecodeErrorZ_free(struct LDKCResult_ChannelConfigDecodeErrorZ _res); +/** + * Creates a new CResult_ChannelConfigDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_ChannelConfigDecodeErrorZ CResult_ChannelConfigDecodeErrorZ_clone(const struct LDKCResult_ChannelConfigDecodeErrorZ *NONNULL_PTR orig); +/** + * Constructs a new COption_u64Z containing a u64 + */ +struct LDKCOption_u64Z COption_u64Z_some(uint64_t o); + +/** + * Constructs a new COption_u64Z containing nothing + */ +struct LDKCOption_u64Z COption_u64Z_none(void); + +/** + * Frees any resources associated with the u64, if we are in the Some state + */ +void COption_u64Z_free(struct LDKCOption_u64Z _res); + +/** + * Creates a new COption_u64Z which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ +struct LDKCOption_u64Z COption_u64Z_clone(const struct LDKCOption_u64Z *NONNULL_PTR orig); + +/** + * Creates a new CResult_DirectionalChannelInfoDecodeErrorZ in the success state. + */ struct LDKCResult_DirectionalChannelInfoDecodeErrorZ CResult_DirectionalChannelInfoDecodeErrorZ_ok(struct LDKDirectionalChannelInfo o); +/** + * Creates a new CResult_DirectionalChannelInfoDecodeErrorZ in the error state. + */ struct LDKCResult_DirectionalChannelInfoDecodeErrorZ CResult_DirectionalChannelInfoDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_DirectionalChannelInfoDecodeErrorZ. + */ void CResult_DirectionalChannelInfoDecodeErrorZ_free(struct LDKCResult_DirectionalChannelInfoDecodeErrorZ _res); +/** + * Creates a new CResult_DirectionalChannelInfoDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_DirectionalChannelInfoDecodeErrorZ CResult_DirectionalChannelInfoDecodeErrorZ_clone(const struct LDKCResult_DirectionalChannelInfoDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_ChannelInfoDecodeErrorZ in the success state. + */ struct LDKCResult_ChannelInfoDecodeErrorZ CResult_ChannelInfoDecodeErrorZ_ok(struct LDKChannelInfo o); +/** + * Creates a new CResult_ChannelInfoDecodeErrorZ in the error state. + */ struct LDKCResult_ChannelInfoDecodeErrorZ CResult_ChannelInfoDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_ChannelInfoDecodeErrorZ. + */ void CResult_ChannelInfoDecodeErrorZ_free(struct LDKCResult_ChannelInfoDecodeErrorZ _res); +/** + * Creates a new CResult_ChannelInfoDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_ChannelInfoDecodeErrorZ CResult_ChannelInfoDecodeErrorZ_clone(const struct LDKCResult_ChannelInfoDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_RoutingFeesDecodeErrorZ in the success state. + */ struct LDKCResult_RoutingFeesDecodeErrorZ CResult_RoutingFeesDecodeErrorZ_ok(struct LDKRoutingFees o); +/** + * Creates a new CResult_RoutingFeesDecodeErrorZ in the error state. + */ struct LDKCResult_RoutingFeesDecodeErrorZ CResult_RoutingFeesDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_RoutingFeesDecodeErrorZ. + */ void CResult_RoutingFeesDecodeErrorZ_free(struct LDKCResult_RoutingFeesDecodeErrorZ _res); +/** + * Creates a new CResult_RoutingFeesDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_RoutingFeesDecodeErrorZ CResult_RoutingFeesDecodeErrorZ_clone(const struct LDKCResult_RoutingFeesDecodeErrorZ *NONNULL_PTR orig); +/** + * Frees the buffer pointed to by `data` if `datalen` is non-0. + */ void CVec_NetAddressZ_free(struct LDKCVec_NetAddressZ _res); +/** + * Creates a new CResult_NodeAnnouncementInfoDecodeErrorZ in the success state. + */ struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ CResult_NodeAnnouncementInfoDecodeErrorZ_ok(struct LDKNodeAnnouncementInfo o); +/** + * Creates a new CResult_NodeAnnouncementInfoDecodeErrorZ in the error state. + */ struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ CResult_NodeAnnouncementInfoDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_NodeAnnouncementInfoDecodeErrorZ. + */ void CResult_NodeAnnouncementInfoDecodeErrorZ_free(struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ _res); +/** + * Creates a new CResult_NodeAnnouncementInfoDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ CResult_NodeAnnouncementInfoDecodeErrorZ_clone(const struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ *NONNULL_PTR orig); +/** + * Frees the buffer pointed to by `data` if `datalen` is non-0. + */ void CVec_u64Z_free(struct LDKCVec_u64Z _res); +/** + * Creates a new CResult_NodeInfoDecodeErrorZ in the success state. + */ struct LDKCResult_NodeInfoDecodeErrorZ CResult_NodeInfoDecodeErrorZ_ok(struct LDKNodeInfo o); +/** + * Creates a new CResult_NodeInfoDecodeErrorZ in the error state. + */ struct LDKCResult_NodeInfoDecodeErrorZ CResult_NodeInfoDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_NodeInfoDecodeErrorZ. + */ void CResult_NodeInfoDecodeErrorZ_free(struct LDKCResult_NodeInfoDecodeErrorZ _res); +/** + * Creates a new CResult_NodeInfoDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_NodeInfoDecodeErrorZ CResult_NodeInfoDecodeErrorZ_clone(const struct LDKCResult_NodeInfoDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_NetworkGraphDecodeErrorZ in the success state. + */ struct LDKCResult_NetworkGraphDecodeErrorZ CResult_NetworkGraphDecodeErrorZ_ok(struct LDKNetworkGraph o); +/** + * Creates a new CResult_NetworkGraphDecodeErrorZ in the error state. + */ struct LDKCResult_NetworkGraphDecodeErrorZ CResult_NetworkGraphDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_NetworkGraphDecodeErrorZ. + */ void CResult_NetworkGraphDecodeErrorZ_free(struct LDKCResult_NetworkGraphDecodeErrorZ _res); +/** + * Creates a new CResult_NetworkGraphDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_NetworkGraphDecodeErrorZ CResult_NetworkGraphDecodeErrorZ_clone(const struct LDKCResult_NetworkGraphDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new C2Tuple_usizeTransactionZ from the contained elements. + */ struct LDKC2Tuple_usizeTransactionZ C2Tuple_usizeTransactionZ_new(uintptr_t a, struct LDKTransaction b); +/** + * Frees any resources used by the C2Tuple_usizeTransactionZ. + */ void C2Tuple_usizeTransactionZ_free(struct LDKC2Tuple_usizeTransactionZ _res); +/** + * Frees the buffer pointed to by `data` if `datalen` is non-0. + */ void CVec_C2Tuple_usizeTransactionZZ_free(struct LDKCVec_C2Tuple_usizeTransactionZZ _res); +/** + * Creates a new CResult_NoneChannelMonitorUpdateErrZ in the success state. + */ struct LDKCResult_NoneChannelMonitorUpdateErrZ CResult_NoneChannelMonitorUpdateErrZ_ok(void); +/** + * Creates a new CResult_NoneChannelMonitorUpdateErrZ in the error state. + */ struct LDKCResult_NoneChannelMonitorUpdateErrZ CResult_NoneChannelMonitorUpdateErrZ_err(enum LDKChannelMonitorUpdateErr e); +/** + * Frees any resources used by the CResult_NoneChannelMonitorUpdateErrZ. + */ void CResult_NoneChannelMonitorUpdateErrZ_free(struct LDKCResult_NoneChannelMonitorUpdateErrZ _res); +/** + * Creates a new CResult_NoneChannelMonitorUpdateErrZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_NoneChannelMonitorUpdateErrZ CResult_NoneChannelMonitorUpdateErrZ_clone(const struct LDKCResult_NoneChannelMonitorUpdateErrZ *NONNULL_PTR orig); +/** + * Frees the buffer pointed to by `data` if `datalen` is non-0. + */ void CVec_MonitorEventZ_free(struct LDKCVec_MonitorEventZ _res); +/** + * Frees the buffer pointed to by `data` if `datalen` is non-0. + */ void CVec_EventZ_free(struct LDKCVec_EventZ _res); +/** + * Creates a new CResult_OutPointDecodeErrorZ in the success state. + */ struct LDKCResult_OutPointDecodeErrorZ CResult_OutPointDecodeErrorZ_ok(struct LDKOutPoint o); +/** + * Creates a new CResult_OutPointDecodeErrorZ in the error state. + */ struct LDKCResult_OutPointDecodeErrorZ CResult_OutPointDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_OutPointDecodeErrorZ. + */ void CResult_OutPointDecodeErrorZ_free(struct LDKCResult_OutPointDecodeErrorZ _res); +/** + * Creates a new CResult_OutPointDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_OutPointDecodeErrorZ CResult_OutPointDecodeErrorZ_clone(const struct LDKCResult_OutPointDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_ChannelMonitorUpdateDecodeErrorZ in the success state. + */ struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ CResult_ChannelMonitorUpdateDecodeErrorZ_ok(struct LDKChannelMonitorUpdate o); +/** + * Creates a new CResult_ChannelMonitorUpdateDecodeErrorZ in the error state. + */ struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ CResult_ChannelMonitorUpdateDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_ChannelMonitorUpdateDecodeErrorZ. + */ void CResult_ChannelMonitorUpdateDecodeErrorZ_free(struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ _res); +/** + * Creates a new CResult_ChannelMonitorUpdateDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ CResult_ChannelMonitorUpdateDecodeErrorZ_clone(const struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_HTLCUpdateDecodeErrorZ in the success state. + */ struct LDKCResult_HTLCUpdateDecodeErrorZ CResult_HTLCUpdateDecodeErrorZ_ok(struct LDKHTLCUpdate o); +/** + * Creates a new CResult_HTLCUpdateDecodeErrorZ in the error state. + */ struct LDKCResult_HTLCUpdateDecodeErrorZ CResult_HTLCUpdateDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_HTLCUpdateDecodeErrorZ. + */ void CResult_HTLCUpdateDecodeErrorZ_free(struct LDKCResult_HTLCUpdateDecodeErrorZ _res); +/** + * Creates a new CResult_HTLCUpdateDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_HTLCUpdateDecodeErrorZ CResult_HTLCUpdateDecodeErrorZ_clone(const struct LDKCResult_HTLCUpdateDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_NoneMonitorUpdateErrorZ in the success state. + */ struct LDKCResult_NoneMonitorUpdateErrorZ CResult_NoneMonitorUpdateErrorZ_ok(void); +/** + * Creates a new CResult_NoneMonitorUpdateErrorZ in the error state. + */ struct LDKCResult_NoneMonitorUpdateErrorZ CResult_NoneMonitorUpdateErrorZ_err(struct LDKMonitorUpdateError e); +/** + * Frees any resources used by the CResult_NoneMonitorUpdateErrorZ. + */ void CResult_NoneMonitorUpdateErrorZ_free(struct LDKCResult_NoneMonitorUpdateErrorZ _res); +/** + * Creates a new CResult_NoneMonitorUpdateErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_NoneMonitorUpdateErrorZ CResult_NoneMonitorUpdateErrorZ_clone(const struct LDKCResult_NoneMonitorUpdateErrorZ *NONNULL_PTR orig); +/** + * Creates a new tuple which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKC2Tuple_OutPointScriptZ C2Tuple_OutPointScriptZ_clone(const struct LDKC2Tuple_OutPointScriptZ *NONNULL_PTR orig); +/** + * Creates a new C2Tuple_OutPointScriptZ from the contained elements. + */ struct LDKC2Tuple_OutPointScriptZ C2Tuple_OutPointScriptZ_new(struct LDKOutPoint a, struct LDKCVec_u8Z b); +/** + * Frees any resources used by the C2Tuple_OutPointScriptZ. + */ void C2Tuple_OutPointScriptZ_free(struct LDKC2Tuple_OutPointScriptZ _res); +/** + * Creates a new tuple which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ +struct LDKC2Tuple_u32ScriptZ C2Tuple_u32ScriptZ_clone(const struct LDKC2Tuple_u32ScriptZ *NONNULL_PTR orig); + +/** + * Creates a new C2Tuple_u32ScriptZ from the contained elements. + */ +struct LDKC2Tuple_u32ScriptZ C2Tuple_u32ScriptZ_new(uint32_t a, struct LDKCVec_u8Z b); + +/** + * Frees any resources used by the C2Tuple_u32ScriptZ. + */ +void C2Tuple_u32ScriptZ_free(struct LDKC2Tuple_u32ScriptZ _res); + +/** + * Frees the buffer pointed to by `data` if `datalen` is non-0. + */ +void CVec_C2Tuple_u32ScriptZZ_free(struct LDKCVec_C2Tuple_u32ScriptZZ _res); + +/** + * Creates a new C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ from the contained elements. + */ +struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ_new(struct LDKThirtyTwoBytes a, struct LDKCVec_C2Tuple_u32ScriptZZ b); + +/** + * Frees any resources used by the C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ. + */ +void C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ_free(struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ _res); + +/** + * Frees the buffer pointed to by `data` if `datalen` is non-0. + */ +void CVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ_free(struct LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ _res); + +/** + * Frees the buffer pointed to by `data` if `datalen` is non-0. + */ void CVec_TransactionZ_free(struct LDKCVec_TransactionZ _res); +/** + * Creates a new tuple which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKC2Tuple_u32TxOutZ C2Tuple_u32TxOutZ_clone(const struct LDKC2Tuple_u32TxOutZ *NONNULL_PTR orig); +/** + * Creates a new C2Tuple_u32TxOutZ from the contained elements. + */ struct LDKC2Tuple_u32TxOutZ C2Tuple_u32TxOutZ_new(uint32_t a, struct LDKTxOut b); +/** + * Frees any resources used by the C2Tuple_u32TxOutZ. + */ void C2Tuple_u32TxOutZ_free(struct LDKC2Tuple_u32TxOutZ _res); +/** + * Frees the buffer pointed to by `data` if `datalen` is non-0. + */ void CVec_C2Tuple_u32TxOutZZ_free(struct LDKCVec_C2Tuple_u32TxOutZZ _res); +/** + * Creates a new C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ from the contained elements. + */ struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ_new(struct LDKThirtyTwoBytes a, struct LDKCVec_C2Tuple_u32TxOutZZ b); +/** + * Frees any resources used by the C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ. + */ void C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ_free(struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ _res); +/** + * Frees the buffer pointed to by `data` if `datalen` is non-0. + */ void CVec_C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZZ_free(struct LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZZ _res); +/** + * Creates a new C2Tuple_BlockHashChannelMonitorZ from the contained elements. + */ struct LDKC2Tuple_BlockHashChannelMonitorZ C2Tuple_BlockHashChannelMonitorZ_new(struct LDKThirtyTwoBytes a, struct LDKChannelMonitor b); +/** + * Frees any resources used by the C2Tuple_BlockHashChannelMonitorZ. + */ void C2Tuple_BlockHashChannelMonitorZ_free(struct LDKC2Tuple_BlockHashChannelMonitorZ _res); +/** + * Creates a new CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ in the success state. + */ struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_ok(struct LDKC2Tuple_BlockHashChannelMonitorZ o); +/** + * Creates a new CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ in the error state. + */ struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ. + */ void CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_free(struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ _res); +/** + * Frees the buffer pointed to by `data` if `datalen` is non-0. + */ void CVec_SpendableOutputDescriptorZ_free(struct LDKCVec_SpendableOutputDescriptorZ _res); +/** + * Creates a new CResult_TxOutAccessErrorZ in the success state. + */ struct LDKCResult_TxOutAccessErrorZ CResult_TxOutAccessErrorZ_ok(struct LDKTxOut o); +/** + * Creates a new CResult_TxOutAccessErrorZ in the error state. + */ struct LDKCResult_TxOutAccessErrorZ CResult_TxOutAccessErrorZ_err(enum LDKAccessError e); +/** + * Frees any resources used by the CResult_TxOutAccessErrorZ. + */ void CResult_TxOutAccessErrorZ_free(struct LDKCResult_TxOutAccessErrorZ _res); -struct LDKCResult_TxOutAccessErrorZ CResult_TxOutAccessErrorZ_clone(const struct LDKCResult_TxOutAccessErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_TxOutAccessErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ +struct LDKCResult_TxOutAccessErrorZ CResult_TxOutAccessErrorZ_clone(const struct LDKCResult_TxOutAccessErrorZ *NONNULL_PTR orig); + +/** + * Constructs a new COption_C2Tuple_usizeTransactionZZ containing a crate::c_types::derived::C2Tuple_usizeTransactionZ + */ +struct LDKCOption_C2Tuple_usizeTransactionZZ COption_C2Tuple_usizeTransactionZZ_some(struct LDKC2Tuple_usizeTransactionZ o); + +/** + * Constructs a new COption_C2Tuple_usizeTransactionZZ containing nothing + */ +struct LDKCOption_C2Tuple_usizeTransactionZZ COption_C2Tuple_usizeTransactionZZ_none(void); + +/** + * Frees any resources associated with the crate::c_types::derived::C2Tuple_usizeTransactionZ, if we are in the Some state + */ +void COption_C2Tuple_usizeTransactionZZ_free(struct LDKCOption_C2Tuple_usizeTransactionZZ _res); +/** + * Creates a new CResult_NoneAPIErrorZ in the success state. + */ struct LDKCResult_NoneAPIErrorZ CResult_NoneAPIErrorZ_ok(void); +/** + * Creates a new CResult_NoneAPIErrorZ in the error state. + */ struct LDKCResult_NoneAPIErrorZ CResult_NoneAPIErrorZ_err(struct LDKAPIError e); +/** + * Frees any resources used by the CResult_NoneAPIErrorZ. + */ void CResult_NoneAPIErrorZ_free(struct LDKCResult_NoneAPIErrorZ _res); +/** + * Creates a new CResult_NoneAPIErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_NoneAPIErrorZ CResult_NoneAPIErrorZ_clone(const struct LDKCResult_NoneAPIErrorZ *NONNULL_PTR orig); +/** + * Frees the buffer pointed to by `data` if `datalen` is non-0. + */ void CVec_CResult_NoneAPIErrorZZ_free(struct LDKCVec_CResult_NoneAPIErrorZZ _res); +/** + * Frees the buffer pointed to by `data` if `datalen` is non-0. + */ void CVec_APIErrorZ_free(struct LDKCVec_APIErrorZ _res); +/** + * Frees the buffer pointed to by `data` if `datalen` is non-0. + */ void CVec_ChannelDetailsZ_free(struct LDKCVec_ChannelDetailsZ _res); +/** + * Creates a new CResult_NonePaymentSendFailureZ in the success state. + */ struct LDKCResult_NonePaymentSendFailureZ CResult_NonePaymentSendFailureZ_ok(void); +/** + * Creates a new CResult_NonePaymentSendFailureZ in the error state. + */ struct LDKCResult_NonePaymentSendFailureZ CResult_NonePaymentSendFailureZ_err(struct LDKPaymentSendFailure e); +/** + * Frees any resources used by the CResult_NonePaymentSendFailureZ. + */ void CResult_NonePaymentSendFailureZ_free(struct LDKCResult_NonePaymentSendFailureZ _res); +/** + * Creates a new CResult_NonePaymentSendFailureZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_NonePaymentSendFailureZ CResult_NonePaymentSendFailureZ_clone(const struct LDKCResult_NonePaymentSendFailureZ *NONNULL_PTR orig); +/** + * Frees the buffer pointed to by `data` if `datalen` is non-0. + */ void CVec_ChannelMonitorZ_free(struct LDKCVec_ChannelMonitorZ _res); +/** + * Creates a new C2Tuple_BlockHashChannelManagerZ from the contained elements. + */ struct LDKC2Tuple_BlockHashChannelManagerZ C2Tuple_BlockHashChannelManagerZ_new(struct LDKThirtyTwoBytes a, struct LDKChannelManager b); +/** + * Frees any resources used by the C2Tuple_BlockHashChannelManagerZ. + */ void C2Tuple_BlockHashChannelManagerZ_free(struct LDKC2Tuple_BlockHashChannelManagerZ _res); +/** + * Creates a new CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ in the success state. + */ struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_ok(struct LDKC2Tuple_BlockHashChannelManagerZ o); +/** + * Creates a new CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ in the error state. + */ struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ. + */ void CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_free(struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ _res); +/** + * Creates a new CResult_SpendableOutputDescriptorDecodeErrorZ in the success state. + */ struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ CResult_SpendableOutputDescriptorDecodeErrorZ_ok(struct LDKSpendableOutputDescriptor o); +/** + * Creates a new CResult_SpendableOutputDescriptorDecodeErrorZ in the error state. + */ struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ CResult_SpendableOutputDescriptorDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_SpendableOutputDescriptorDecodeErrorZ. + */ void CResult_SpendableOutputDescriptorDecodeErrorZ_free(struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ _res); +/** + * Creates a new CResult_SpendableOutputDescriptorDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ CResult_SpendableOutputDescriptorDecodeErrorZ_clone(const struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new tuple which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKC2Tuple_SignatureCVec_SignatureZZ C2Tuple_SignatureCVec_SignatureZZ_clone(const struct LDKC2Tuple_SignatureCVec_SignatureZZ *NONNULL_PTR orig); +/** + * Creates a new C2Tuple_SignatureCVec_SignatureZZ from the contained elements. + */ struct LDKC2Tuple_SignatureCVec_SignatureZZ C2Tuple_SignatureCVec_SignatureZZ_new(struct LDKSignature a, struct LDKCVec_SignatureZ b); +/** + * Frees any resources used by the C2Tuple_SignatureCVec_SignatureZZ. + */ void C2Tuple_SignatureCVec_SignatureZZ_free(struct LDKC2Tuple_SignatureCVec_SignatureZZ _res); +/** + * Creates a new CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ in the success state. + */ struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ_ok(struct LDKC2Tuple_SignatureCVec_SignatureZZ o); +/** + * Creates a new CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ in the error state. + */ struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ_err(void); +/** + * Frees any resources used by the CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ. + */ void CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ_free(struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ _res); +/** + * Creates a new CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ_clone(const struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ *NONNULL_PTR orig); +/** + * Creates a new CResult_SignatureNoneZ in the success state. + */ struct LDKCResult_SignatureNoneZ CResult_SignatureNoneZ_ok(struct LDKSignature o); +/** + * Creates a new CResult_SignatureNoneZ in the error state. + */ struct LDKCResult_SignatureNoneZ CResult_SignatureNoneZ_err(void); +/** + * Frees any resources used by the CResult_SignatureNoneZ. + */ void CResult_SignatureNoneZ_free(struct LDKCResult_SignatureNoneZ _res); +/** + * Creates a new CResult_SignatureNoneZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_SignatureNoneZ CResult_SignatureNoneZ_clone(const struct LDKCResult_SignatureNoneZ *NONNULL_PTR orig); +/** + * Creates a new CResult_SignDecodeErrorZ in the success state. + */ struct LDKCResult_SignDecodeErrorZ CResult_SignDecodeErrorZ_ok(struct LDKSign o); +/** + * Creates a new CResult_SignDecodeErrorZ in the error state. + */ struct LDKCResult_SignDecodeErrorZ CResult_SignDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_SignDecodeErrorZ. + */ void CResult_SignDecodeErrorZ_free(struct LDKCResult_SignDecodeErrorZ _res); +/** + * Creates a new CResult_SignDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_SignDecodeErrorZ CResult_SignDecodeErrorZ_clone(const struct LDKCResult_SignDecodeErrorZ *NONNULL_PTR orig); +/** + * Frees the buffer pointed to by `data` if `datalen` is non-0. + */ void CVec_CVec_u8ZZ_free(struct LDKCVec_CVec_u8ZZ _res); +/** + * Creates a new CResult_CVec_CVec_u8ZZNoneZ in the success state. + */ struct LDKCResult_CVec_CVec_u8ZZNoneZ CResult_CVec_CVec_u8ZZNoneZ_ok(struct LDKCVec_CVec_u8ZZ o); +/** + * Creates a new CResult_CVec_CVec_u8ZZNoneZ in the error state. + */ struct LDKCResult_CVec_CVec_u8ZZNoneZ CResult_CVec_CVec_u8ZZNoneZ_err(void); +/** + * Frees any resources used by the CResult_CVec_CVec_u8ZZNoneZ. + */ void CResult_CVec_CVec_u8ZZNoneZ_free(struct LDKCResult_CVec_CVec_u8ZZNoneZ _res); +/** + * Creates a new CResult_CVec_CVec_u8ZZNoneZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_CVec_CVec_u8ZZNoneZ CResult_CVec_CVec_u8ZZNoneZ_clone(const struct LDKCResult_CVec_CVec_u8ZZNoneZ *NONNULL_PTR orig); +/** + * Creates a new CResult_InMemorySignerDecodeErrorZ in the success state. + */ struct LDKCResult_InMemorySignerDecodeErrorZ CResult_InMemorySignerDecodeErrorZ_ok(struct LDKInMemorySigner o); +/** + * Creates a new CResult_InMemorySignerDecodeErrorZ in the error state. + */ struct LDKCResult_InMemorySignerDecodeErrorZ CResult_InMemorySignerDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_InMemorySignerDecodeErrorZ. + */ void CResult_InMemorySignerDecodeErrorZ_free(struct LDKCResult_InMemorySignerDecodeErrorZ _res); +/** + * Creates a new CResult_InMemorySignerDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_InMemorySignerDecodeErrorZ CResult_InMemorySignerDecodeErrorZ_clone(const struct LDKCResult_InMemorySignerDecodeErrorZ *NONNULL_PTR orig); +/** + * Frees the buffer pointed to by `data` if `datalen` is non-0. + */ void CVec_TxOutZ_free(struct LDKCVec_TxOutZ _res); +/** + * Creates a new CResult_TransactionNoneZ in the success state. + */ struct LDKCResult_TransactionNoneZ CResult_TransactionNoneZ_ok(struct LDKTransaction o); +/** + * Creates a new CResult_TransactionNoneZ in the error state. + */ struct LDKCResult_TransactionNoneZ CResult_TransactionNoneZ_err(void); +/** + * Frees any resources used by the CResult_TransactionNoneZ. + */ void CResult_TransactionNoneZ_free(struct LDKCResult_TransactionNoneZ _res); +/** + * Frees the buffer pointed to by `data` if `datalen` is non-0. + */ void CVec_RouteHopZ_free(struct LDKCVec_RouteHopZ _res); +/** + * Frees the buffer pointed to by `data` if `datalen` is non-0. + */ void CVec_CVec_RouteHopZZ_free(struct LDKCVec_CVec_RouteHopZZ _res); +/** + * Creates a new CResult_RouteDecodeErrorZ in the success state. + */ struct LDKCResult_RouteDecodeErrorZ CResult_RouteDecodeErrorZ_ok(struct LDKRoute o); +/** + * Creates a new CResult_RouteDecodeErrorZ in the error state. + */ struct LDKCResult_RouteDecodeErrorZ CResult_RouteDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_RouteDecodeErrorZ. + */ void CResult_RouteDecodeErrorZ_free(struct LDKCResult_RouteDecodeErrorZ _res); +/** + * Creates a new CResult_RouteDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_RouteDecodeErrorZ CResult_RouteDecodeErrorZ_clone(const struct LDKCResult_RouteDecodeErrorZ *NONNULL_PTR orig); +/** + * Frees the buffer pointed to by `data` if `datalen` is non-0. + */ void CVec_RouteHintZ_free(struct LDKCVec_RouteHintZ _res); +/** + * Creates a new CResult_RouteLightningErrorZ in the success state. + */ struct LDKCResult_RouteLightningErrorZ CResult_RouteLightningErrorZ_ok(struct LDKRoute o); +/** + * Creates a new CResult_RouteLightningErrorZ in the error state. + */ struct LDKCResult_RouteLightningErrorZ CResult_RouteLightningErrorZ_err(struct LDKLightningError e); +/** + * Frees any resources used by the CResult_RouteLightningErrorZ. + */ void CResult_RouteLightningErrorZ_free(struct LDKCResult_RouteLightningErrorZ _res); +/** + * Creates a new CResult_RouteLightningErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_RouteLightningErrorZ CResult_RouteLightningErrorZ_clone(const struct LDKCResult_RouteLightningErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_NetAddressu8Z in the success state. + */ struct LDKCResult_NetAddressu8Z CResult_NetAddressu8Z_ok(struct LDKNetAddress o); +/** + * Creates a new CResult_NetAddressu8Z in the error state. + */ struct LDKCResult_NetAddressu8Z CResult_NetAddressu8Z_err(uint8_t e); +/** + * Frees any resources used by the CResult_NetAddressu8Z. + */ void CResult_NetAddressu8Z_free(struct LDKCResult_NetAddressu8Z _res); +/** + * Creates a new CResult_NetAddressu8Z which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_NetAddressu8Z CResult_NetAddressu8Z_clone(const struct LDKCResult_NetAddressu8Z *NONNULL_PTR orig); +/** + * Creates a new CResult_CResult_NetAddressu8ZDecodeErrorZ in the success state. + */ struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ CResult_CResult_NetAddressu8ZDecodeErrorZ_ok(struct LDKCResult_NetAddressu8Z o); +/** + * Creates a new CResult_CResult_NetAddressu8ZDecodeErrorZ in the error state. + */ struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ CResult_CResult_NetAddressu8ZDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_CResult_NetAddressu8ZDecodeErrorZ. + */ void CResult_CResult_NetAddressu8ZDecodeErrorZ_free(struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ _res); +/** + * Creates a new CResult_CResult_NetAddressu8ZDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ CResult_CResult_NetAddressu8ZDecodeErrorZ_clone(const struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ *NONNULL_PTR orig); +/** + * Frees the buffer pointed to by `data` if `datalen` is non-0. + */ void CVec_UpdateAddHTLCZ_free(struct LDKCVec_UpdateAddHTLCZ _res); +/** + * Frees the buffer pointed to by `data` if `datalen` is non-0. + */ void CVec_UpdateFulfillHTLCZ_free(struct LDKCVec_UpdateFulfillHTLCZ _res); +/** + * Frees the buffer pointed to by `data` if `datalen` is non-0. + */ void CVec_UpdateFailHTLCZ_free(struct LDKCVec_UpdateFailHTLCZ _res); +/** + * Frees the buffer pointed to by `data` if `datalen` is non-0. + */ void CVec_UpdateFailMalformedHTLCZ_free(struct LDKCVec_UpdateFailMalformedHTLCZ _res); +/** + * Creates a new CResult_AcceptChannelDecodeErrorZ in the success state. + */ struct LDKCResult_AcceptChannelDecodeErrorZ CResult_AcceptChannelDecodeErrorZ_ok(struct LDKAcceptChannel o); +/** + * Creates a new CResult_AcceptChannelDecodeErrorZ in the error state. + */ struct LDKCResult_AcceptChannelDecodeErrorZ CResult_AcceptChannelDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_AcceptChannelDecodeErrorZ. + */ void CResult_AcceptChannelDecodeErrorZ_free(struct LDKCResult_AcceptChannelDecodeErrorZ _res); +/** + * Creates a new CResult_AcceptChannelDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_AcceptChannelDecodeErrorZ CResult_AcceptChannelDecodeErrorZ_clone(const struct LDKCResult_AcceptChannelDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_AnnouncementSignaturesDecodeErrorZ in the success state. + */ struct LDKCResult_AnnouncementSignaturesDecodeErrorZ CResult_AnnouncementSignaturesDecodeErrorZ_ok(struct LDKAnnouncementSignatures o); +/** + * Creates a new CResult_AnnouncementSignaturesDecodeErrorZ in the error state. + */ struct LDKCResult_AnnouncementSignaturesDecodeErrorZ CResult_AnnouncementSignaturesDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_AnnouncementSignaturesDecodeErrorZ. + */ void CResult_AnnouncementSignaturesDecodeErrorZ_free(struct LDKCResult_AnnouncementSignaturesDecodeErrorZ _res); +/** + * Creates a new CResult_AnnouncementSignaturesDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_AnnouncementSignaturesDecodeErrorZ CResult_AnnouncementSignaturesDecodeErrorZ_clone(const struct LDKCResult_AnnouncementSignaturesDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_ChannelReestablishDecodeErrorZ in the success state. + */ struct LDKCResult_ChannelReestablishDecodeErrorZ CResult_ChannelReestablishDecodeErrorZ_ok(struct LDKChannelReestablish o); +/** + * Creates a new CResult_ChannelReestablishDecodeErrorZ in the error state. + */ struct LDKCResult_ChannelReestablishDecodeErrorZ CResult_ChannelReestablishDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_ChannelReestablishDecodeErrorZ. + */ void CResult_ChannelReestablishDecodeErrorZ_free(struct LDKCResult_ChannelReestablishDecodeErrorZ _res); +/** + * Creates a new CResult_ChannelReestablishDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_ChannelReestablishDecodeErrorZ CResult_ChannelReestablishDecodeErrorZ_clone(const struct LDKCResult_ChannelReestablishDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_ClosingSignedDecodeErrorZ in the success state. + */ struct LDKCResult_ClosingSignedDecodeErrorZ CResult_ClosingSignedDecodeErrorZ_ok(struct LDKClosingSigned o); +/** + * Creates a new CResult_ClosingSignedDecodeErrorZ in the error state. + */ struct LDKCResult_ClosingSignedDecodeErrorZ CResult_ClosingSignedDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_ClosingSignedDecodeErrorZ. + */ void CResult_ClosingSignedDecodeErrorZ_free(struct LDKCResult_ClosingSignedDecodeErrorZ _res); +/** + * Creates a new CResult_ClosingSignedDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_ClosingSignedDecodeErrorZ CResult_ClosingSignedDecodeErrorZ_clone(const struct LDKCResult_ClosingSignedDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_CommitmentSignedDecodeErrorZ in the success state. + */ struct LDKCResult_CommitmentSignedDecodeErrorZ CResult_CommitmentSignedDecodeErrorZ_ok(struct LDKCommitmentSigned o); +/** + * Creates a new CResult_CommitmentSignedDecodeErrorZ in the error state. + */ struct LDKCResult_CommitmentSignedDecodeErrorZ CResult_CommitmentSignedDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_CommitmentSignedDecodeErrorZ. + */ void CResult_CommitmentSignedDecodeErrorZ_free(struct LDKCResult_CommitmentSignedDecodeErrorZ _res); +/** + * Creates a new CResult_CommitmentSignedDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_CommitmentSignedDecodeErrorZ CResult_CommitmentSignedDecodeErrorZ_clone(const struct LDKCResult_CommitmentSignedDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_FundingCreatedDecodeErrorZ in the success state. + */ struct LDKCResult_FundingCreatedDecodeErrorZ CResult_FundingCreatedDecodeErrorZ_ok(struct LDKFundingCreated o); +/** + * Creates a new CResult_FundingCreatedDecodeErrorZ in the error state. + */ struct LDKCResult_FundingCreatedDecodeErrorZ CResult_FundingCreatedDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_FundingCreatedDecodeErrorZ. + */ void CResult_FundingCreatedDecodeErrorZ_free(struct LDKCResult_FundingCreatedDecodeErrorZ _res); +/** + * Creates a new CResult_FundingCreatedDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_FundingCreatedDecodeErrorZ CResult_FundingCreatedDecodeErrorZ_clone(const struct LDKCResult_FundingCreatedDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_FundingSignedDecodeErrorZ in the success state. + */ struct LDKCResult_FundingSignedDecodeErrorZ CResult_FundingSignedDecodeErrorZ_ok(struct LDKFundingSigned o); +/** + * Creates a new CResult_FundingSignedDecodeErrorZ in the error state. + */ struct LDKCResult_FundingSignedDecodeErrorZ CResult_FundingSignedDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_FundingSignedDecodeErrorZ. + */ void CResult_FundingSignedDecodeErrorZ_free(struct LDKCResult_FundingSignedDecodeErrorZ _res); +/** + * Creates a new CResult_FundingSignedDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_FundingSignedDecodeErrorZ CResult_FundingSignedDecodeErrorZ_clone(const struct LDKCResult_FundingSignedDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_FundingLockedDecodeErrorZ in the success state. + */ struct LDKCResult_FundingLockedDecodeErrorZ CResult_FundingLockedDecodeErrorZ_ok(struct LDKFundingLocked o); +/** + * Creates a new CResult_FundingLockedDecodeErrorZ in the error state. + */ struct LDKCResult_FundingLockedDecodeErrorZ CResult_FundingLockedDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_FundingLockedDecodeErrorZ. + */ void CResult_FundingLockedDecodeErrorZ_free(struct LDKCResult_FundingLockedDecodeErrorZ _res); +/** + * Creates a new CResult_FundingLockedDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_FundingLockedDecodeErrorZ CResult_FundingLockedDecodeErrorZ_clone(const struct LDKCResult_FundingLockedDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_InitDecodeErrorZ in the success state. + */ struct LDKCResult_InitDecodeErrorZ CResult_InitDecodeErrorZ_ok(struct LDKInit o); +/** + * Creates a new CResult_InitDecodeErrorZ in the error state. + */ struct LDKCResult_InitDecodeErrorZ CResult_InitDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_InitDecodeErrorZ. + */ void CResult_InitDecodeErrorZ_free(struct LDKCResult_InitDecodeErrorZ _res); +/** + * Creates a new CResult_InitDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_InitDecodeErrorZ CResult_InitDecodeErrorZ_clone(const struct LDKCResult_InitDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_OpenChannelDecodeErrorZ in the success state. + */ struct LDKCResult_OpenChannelDecodeErrorZ CResult_OpenChannelDecodeErrorZ_ok(struct LDKOpenChannel o); +/** + * Creates a new CResult_OpenChannelDecodeErrorZ in the error state. + */ struct LDKCResult_OpenChannelDecodeErrorZ CResult_OpenChannelDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_OpenChannelDecodeErrorZ. + */ void CResult_OpenChannelDecodeErrorZ_free(struct LDKCResult_OpenChannelDecodeErrorZ _res); +/** + * Creates a new CResult_OpenChannelDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_OpenChannelDecodeErrorZ CResult_OpenChannelDecodeErrorZ_clone(const struct LDKCResult_OpenChannelDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_RevokeAndACKDecodeErrorZ in the success state. + */ struct LDKCResult_RevokeAndACKDecodeErrorZ CResult_RevokeAndACKDecodeErrorZ_ok(struct LDKRevokeAndACK o); +/** + * Creates a new CResult_RevokeAndACKDecodeErrorZ in the error state. + */ struct LDKCResult_RevokeAndACKDecodeErrorZ CResult_RevokeAndACKDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_RevokeAndACKDecodeErrorZ. + */ void CResult_RevokeAndACKDecodeErrorZ_free(struct LDKCResult_RevokeAndACKDecodeErrorZ _res); +/** + * Creates a new CResult_RevokeAndACKDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_RevokeAndACKDecodeErrorZ CResult_RevokeAndACKDecodeErrorZ_clone(const struct LDKCResult_RevokeAndACKDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_ShutdownDecodeErrorZ in the success state. + */ struct LDKCResult_ShutdownDecodeErrorZ CResult_ShutdownDecodeErrorZ_ok(struct LDKShutdown o); +/** + * Creates a new CResult_ShutdownDecodeErrorZ in the error state. + */ struct LDKCResult_ShutdownDecodeErrorZ CResult_ShutdownDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_ShutdownDecodeErrorZ. + */ void CResult_ShutdownDecodeErrorZ_free(struct LDKCResult_ShutdownDecodeErrorZ _res); +/** + * Creates a new CResult_ShutdownDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_ShutdownDecodeErrorZ CResult_ShutdownDecodeErrorZ_clone(const struct LDKCResult_ShutdownDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_UpdateFailHTLCDecodeErrorZ in the success state. + */ struct LDKCResult_UpdateFailHTLCDecodeErrorZ CResult_UpdateFailHTLCDecodeErrorZ_ok(struct LDKUpdateFailHTLC o); +/** + * Creates a new CResult_UpdateFailHTLCDecodeErrorZ in the error state. + */ struct LDKCResult_UpdateFailHTLCDecodeErrorZ CResult_UpdateFailHTLCDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_UpdateFailHTLCDecodeErrorZ. + */ void CResult_UpdateFailHTLCDecodeErrorZ_free(struct LDKCResult_UpdateFailHTLCDecodeErrorZ _res); +/** + * Creates a new CResult_UpdateFailHTLCDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_UpdateFailHTLCDecodeErrorZ CResult_UpdateFailHTLCDecodeErrorZ_clone(const struct LDKCResult_UpdateFailHTLCDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_UpdateFailMalformedHTLCDecodeErrorZ in the success state. + */ struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ CResult_UpdateFailMalformedHTLCDecodeErrorZ_ok(struct LDKUpdateFailMalformedHTLC o); +/** + * Creates a new CResult_UpdateFailMalformedHTLCDecodeErrorZ in the error state. + */ struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ CResult_UpdateFailMalformedHTLCDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_UpdateFailMalformedHTLCDecodeErrorZ. + */ void CResult_UpdateFailMalformedHTLCDecodeErrorZ_free(struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ _res); +/** + * Creates a new CResult_UpdateFailMalformedHTLCDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ CResult_UpdateFailMalformedHTLCDecodeErrorZ_clone(const struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_UpdateFeeDecodeErrorZ in the success state. + */ struct LDKCResult_UpdateFeeDecodeErrorZ CResult_UpdateFeeDecodeErrorZ_ok(struct LDKUpdateFee o); +/** + * Creates a new CResult_UpdateFeeDecodeErrorZ in the error state. + */ struct LDKCResult_UpdateFeeDecodeErrorZ CResult_UpdateFeeDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_UpdateFeeDecodeErrorZ. + */ void CResult_UpdateFeeDecodeErrorZ_free(struct LDKCResult_UpdateFeeDecodeErrorZ _res); +/** + * Creates a new CResult_UpdateFeeDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_UpdateFeeDecodeErrorZ CResult_UpdateFeeDecodeErrorZ_clone(const struct LDKCResult_UpdateFeeDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_UpdateFulfillHTLCDecodeErrorZ in the success state. + */ struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ CResult_UpdateFulfillHTLCDecodeErrorZ_ok(struct LDKUpdateFulfillHTLC o); +/** + * Creates a new CResult_UpdateFulfillHTLCDecodeErrorZ in the error state. + */ struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ CResult_UpdateFulfillHTLCDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_UpdateFulfillHTLCDecodeErrorZ. + */ void CResult_UpdateFulfillHTLCDecodeErrorZ_free(struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ _res); +/** + * Creates a new CResult_UpdateFulfillHTLCDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ CResult_UpdateFulfillHTLCDecodeErrorZ_clone(const struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_UpdateAddHTLCDecodeErrorZ in the success state. + */ struct LDKCResult_UpdateAddHTLCDecodeErrorZ CResult_UpdateAddHTLCDecodeErrorZ_ok(struct LDKUpdateAddHTLC o); +/** + * Creates a new CResult_UpdateAddHTLCDecodeErrorZ in the error state. + */ struct LDKCResult_UpdateAddHTLCDecodeErrorZ CResult_UpdateAddHTLCDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_UpdateAddHTLCDecodeErrorZ. + */ void CResult_UpdateAddHTLCDecodeErrorZ_free(struct LDKCResult_UpdateAddHTLCDecodeErrorZ _res); +/** + * Creates a new CResult_UpdateAddHTLCDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_UpdateAddHTLCDecodeErrorZ CResult_UpdateAddHTLCDecodeErrorZ_clone(const struct LDKCResult_UpdateAddHTLCDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_PingDecodeErrorZ in the success state. + */ struct LDKCResult_PingDecodeErrorZ CResult_PingDecodeErrorZ_ok(struct LDKPing o); +/** + * Creates a new CResult_PingDecodeErrorZ in the error state. + */ struct LDKCResult_PingDecodeErrorZ CResult_PingDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_PingDecodeErrorZ. + */ void CResult_PingDecodeErrorZ_free(struct LDKCResult_PingDecodeErrorZ _res); +/** + * Creates a new CResult_PingDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_PingDecodeErrorZ CResult_PingDecodeErrorZ_clone(const struct LDKCResult_PingDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_PongDecodeErrorZ in the success state. + */ struct LDKCResult_PongDecodeErrorZ CResult_PongDecodeErrorZ_ok(struct LDKPong o); +/** + * Creates a new CResult_PongDecodeErrorZ in the error state. + */ struct LDKCResult_PongDecodeErrorZ CResult_PongDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_PongDecodeErrorZ. + */ void CResult_PongDecodeErrorZ_free(struct LDKCResult_PongDecodeErrorZ _res); +/** + * Creates a new CResult_PongDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_PongDecodeErrorZ CResult_PongDecodeErrorZ_clone(const struct LDKCResult_PongDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_UnsignedChannelAnnouncementDecodeErrorZ in the success state. + */ struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ CResult_UnsignedChannelAnnouncementDecodeErrorZ_ok(struct LDKUnsignedChannelAnnouncement o); +/** + * Creates a new CResult_UnsignedChannelAnnouncementDecodeErrorZ in the error state. + */ struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ CResult_UnsignedChannelAnnouncementDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_UnsignedChannelAnnouncementDecodeErrorZ. + */ void CResult_UnsignedChannelAnnouncementDecodeErrorZ_free(struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ _res); +/** + * Creates a new CResult_UnsignedChannelAnnouncementDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ CResult_UnsignedChannelAnnouncementDecodeErrorZ_clone(const struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_ChannelAnnouncementDecodeErrorZ in the success state. + */ struct LDKCResult_ChannelAnnouncementDecodeErrorZ CResult_ChannelAnnouncementDecodeErrorZ_ok(struct LDKChannelAnnouncement o); +/** + * Creates a new CResult_ChannelAnnouncementDecodeErrorZ in the error state. + */ struct LDKCResult_ChannelAnnouncementDecodeErrorZ CResult_ChannelAnnouncementDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_ChannelAnnouncementDecodeErrorZ. + */ void CResult_ChannelAnnouncementDecodeErrorZ_free(struct LDKCResult_ChannelAnnouncementDecodeErrorZ _res); +/** + * Creates a new CResult_ChannelAnnouncementDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_ChannelAnnouncementDecodeErrorZ CResult_ChannelAnnouncementDecodeErrorZ_clone(const struct LDKCResult_ChannelAnnouncementDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_UnsignedChannelUpdateDecodeErrorZ in the success state. + */ struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ CResult_UnsignedChannelUpdateDecodeErrorZ_ok(struct LDKUnsignedChannelUpdate o); +/** + * Creates a new CResult_UnsignedChannelUpdateDecodeErrorZ in the error state. + */ struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ CResult_UnsignedChannelUpdateDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_UnsignedChannelUpdateDecodeErrorZ. + */ void CResult_UnsignedChannelUpdateDecodeErrorZ_free(struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ _res); +/** + * Creates a new CResult_UnsignedChannelUpdateDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ CResult_UnsignedChannelUpdateDecodeErrorZ_clone(const struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_ChannelUpdateDecodeErrorZ in the success state. + */ struct LDKCResult_ChannelUpdateDecodeErrorZ CResult_ChannelUpdateDecodeErrorZ_ok(struct LDKChannelUpdate o); +/** + * Creates a new CResult_ChannelUpdateDecodeErrorZ in the error state. + */ struct LDKCResult_ChannelUpdateDecodeErrorZ CResult_ChannelUpdateDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_ChannelUpdateDecodeErrorZ. + */ void CResult_ChannelUpdateDecodeErrorZ_free(struct LDKCResult_ChannelUpdateDecodeErrorZ _res); +/** + * Creates a new CResult_ChannelUpdateDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_ChannelUpdateDecodeErrorZ CResult_ChannelUpdateDecodeErrorZ_clone(const struct LDKCResult_ChannelUpdateDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_ErrorMessageDecodeErrorZ in the success state. + */ struct LDKCResult_ErrorMessageDecodeErrorZ CResult_ErrorMessageDecodeErrorZ_ok(struct LDKErrorMessage o); +/** + * Creates a new CResult_ErrorMessageDecodeErrorZ in the error state. + */ struct LDKCResult_ErrorMessageDecodeErrorZ CResult_ErrorMessageDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_ErrorMessageDecodeErrorZ. + */ void CResult_ErrorMessageDecodeErrorZ_free(struct LDKCResult_ErrorMessageDecodeErrorZ _res); +/** + * Creates a new CResult_ErrorMessageDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_ErrorMessageDecodeErrorZ CResult_ErrorMessageDecodeErrorZ_clone(const struct LDKCResult_ErrorMessageDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_UnsignedNodeAnnouncementDecodeErrorZ in the success state. + */ struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ CResult_UnsignedNodeAnnouncementDecodeErrorZ_ok(struct LDKUnsignedNodeAnnouncement o); +/** + * Creates a new CResult_UnsignedNodeAnnouncementDecodeErrorZ in the error state. + */ struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ CResult_UnsignedNodeAnnouncementDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_UnsignedNodeAnnouncementDecodeErrorZ. + */ void CResult_UnsignedNodeAnnouncementDecodeErrorZ_free(struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ _res); +/** + * Creates a new CResult_UnsignedNodeAnnouncementDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ CResult_UnsignedNodeAnnouncementDecodeErrorZ_clone(const struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_NodeAnnouncementDecodeErrorZ in the success state. + */ struct LDKCResult_NodeAnnouncementDecodeErrorZ CResult_NodeAnnouncementDecodeErrorZ_ok(struct LDKNodeAnnouncement o); +/** + * Creates a new CResult_NodeAnnouncementDecodeErrorZ in the error state. + */ struct LDKCResult_NodeAnnouncementDecodeErrorZ CResult_NodeAnnouncementDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_NodeAnnouncementDecodeErrorZ. + */ void CResult_NodeAnnouncementDecodeErrorZ_free(struct LDKCResult_NodeAnnouncementDecodeErrorZ _res); +/** + * Creates a new CResult_NodeAnnouncementDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_NodeAnnouncementDecodeErrorZ CResult_NodeAnnouncementDecodeErrorZ_clone(const struct LDKCResult_NodeAnnouncementDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_QueryShortChannelIdsDecodeErrorZ in the success state. + */ struct LDKCResult_QueryShortChannelIdsDecodeErrorZ CResult_QueryShortChannelIdsDecodeErrorZ_ok(struct LDKQueryShortChannelIds o); +/** + * Creates a new CResult_QueryShortChannelIdsDecodeErrorZ in the error state. + */ struct LDKCResult_QueryShortChannelIdsDecodeErrorZ CResult_QueryShortChannelIdsDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_QueryShortChannelIdsDecodeErrorZ. + */ void CResult_QueryShortChannelIdsDecodeErrorZ_free(struct LDKCResult_QueryShortChannelIdsDecodeErrorZ _res); +/** + * Creates a new CResult_QueryShortChannelIdsDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_QueryShortChannelIdsDecodeErrorZ CResult_QueryShortChannelIdsDecodeErrorZ_clone(const struct LDKCResult_QueryShortChannelIdsDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_ReplyShortChannelIdsEndDecodeErrorZ in the success state. + */ struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ CResult_ReplyShortChannelIdsEndDecodeErrorZ_ok(struct LDKReplyShortChannelIdsEnd o); +/** + * Creates a new CResult_ReplyShortChannelIdsEndDecodeErrorZ in the error state. + */ struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ CResult_ReplyShortChannelIdsEndDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_ReplyShortChannelIdsEndDecodeErrorZ. + */ void CResult_ReplyShortChannelIdsEndDecodeErrorZ_free(struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ _res); +/** + * Creates a new CResult_ReplyShortChannelIdsEndDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ CResult_ReplyShortChannelIdsEndDecodeErrorZ_clone(const struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_QueryChannelRangeDecodeErrorZ in the success state. + */ struct LDKCResult_QueryChannelRangeDecodeErrorZ CResult_QueryChannelRangeDecodeErrorZ_ok(struct LDKQueryChannelRange o); +/** + * Creates a new CResult_QueryChannelRangeDecodeErrorZ in the error state. + */ struct LDKCResult_QueryChannelRangeDecodeErrorZ CResult_QueryChannelRangeDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_QueryChannelRangeDecodeErrorZ. + */ void CResult_QueryChannelRangeDecodeErrorZ_free(struct LDKCResult_QueryChannelRangeDecodeErrorZ _res); +/** + * Creates a new CResult_QueryChannelRangeDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_QueryChannelRangeDecodeErrorZ CResult_QueryChannelRangeDecodeErrorZ_clone(const struct LDKCResult_QueryChannelRangeDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_ReplyChannelRangeDecodeErrorZ in the success state. + */ struct LDKCResult_ReplyChannelRangeDecodeErrorZ CResult_ReplyChannelRangeDecodeErrorZ_ok(struct LDKReplyChannelRange o); +/** + * Creates a new CResult_ReplyChannelRangeDecodeErrorZ in the error state. + */ struct LDKCResult_ReplyChannelRangeDecodeErrorZ CResult_ReplyChannelRangeDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_ReplyChannelRangeDecodeErrorZ. + */ void CResult_ReplyChannelRangeDecodeErrorZ_free(struct LDKCResult_ReplyChannelRangeDecodeErrorZ _res); +/** + * Creates a new CResult_ReplyChannelRangeDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_ReplyChannelRangeDecodeErrorZ CResult_ReplyChannelRangeDecodeErrorZ_clone(const struct LDKCResult_ReplyChannelRangeDecodeErrorZ *NONNULL_PTR orig); +/** + * Creates a new CResult_GossipTimestampFilterDecodeErrorZ in the success state. + */ struct LDKCResult_GossipTimestampFilterDecodeErrorZ CResult_GossipTimestampFilterDecodeErrorZ_ok(struct LDKGossipTimestampFilter o); +/** + * Creates a new CResult_GossipTimestampFilterDecodeErrorZ in the error state. + */ struct LDKCResult_GossipTimestampFilterDecodeErrorZ CResult_GossipTimestampFilterDecodeErrorZ_err(struct LDKDecodeError e); +/** + * Frees any resources used by the CResult_GossipTimestampFilterDecodeErrorZ. + */ void CResult_GossipTimestampFilterDecodeErrorZ_free(struct LDKCResult_GossipTimestampFilterDecodeErrorZ _res); +/** + * Creates a new CResult_GossipTimestampFilterDecodeErrorZ which has the same data as `orig` + * but with all dynamically-allocated buffers duplicated in new buffers. + */ struct LDKCResult_GossipTimestampFilterDecodeErrorZ CResult_GossipTimestampFilterDecodeErrorZ_clone(const struct LDKCResult_GossipTimestampFilterDecodeErrorZ *NONNULL_PTR orig); +/** + * Frees any resources used by the Event + */ void Event_free(struct LDKEvent this_ptr); +/** + * Creates a copy of the Event + */ struct LDKEvent Event_clone(const struct LDKEvent *NONNULL_PTR orig); +/** + * Serialize the Event object into a byte array which can be read by Event_read + */ struct LDKCVec_u8Z Event_write(const struct LDKEvent *NONNULL_PTR obj); +/** + * Frees any resources used by the MessageSendEvent + */ void MessageSendEvent_free(struct LDKMessageSendEvent this_ptr); +/** + * Creates a copy of the MessageSendEvent + */ struct LDKMessageSendEvent MessageSendEvent_clone(const struct LDKMessageSendEvent *NONNULL_PTR orig); /** @@ -4771,10 +9461,19 @@ void MessageSendEventsProvider_free(struct LDKMessageSendEventsProvider this_ptr */ void EventsProvider_free(struct LDKEventsProvider this_ptr); +/** + * Frees any resources used by the APIError + */ void APIError_free(struct LDKAPIError this_ptr); +/** + * Creates a copy of the APIError + */ struct LDKAPIError APIError_clone(const struct LDKAPIError *NONNULL_PTR orig); +/** + * Creates a copy of the Level + */ enum LDKLevel Level_clone(const enum LDKLevel *NONNULL_PTR orig); /** @@ -4787,7 +9486,10 @@ MUST_USE_RES enum LDKLevel Level_max(void); */ void Logger_free(struct LDKLogger this_ptr); -void ChannelHandshakeConfig_free(struct LDKChannelHandshakeConfig this_ptr); +/** + * Frees any resources used by the ChannelHandshakeConfig, if is_owned is set and inner is non-NULL. + */ +void ChannelHandshakeConfig_free(struct LDKChannelHandshakeConfig this_obj); /** * Confirmations we will wait for before considering the channel locked in. @@ -4808,34 +9510,40 @@ uint32_t ChannelHandshakeConfig_get_minimum_depth(const struct LDKChannelHandsha void ChannelHandshakeConfig_set_minimum_depth(struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr, uint32_t val); /** - * Set to the amount of time we require our counterparty to wait to claim their money. + * Set to the number of blocks we require our counterparty to wait to claim their money (ie + * the number of blocks we have to punish our counterparty if they broadcast a revoked + * transaction). * - * It's one of the main parameter of our security model. We (or one of our watchtowers) MUST - * be online to check for peer having broadcast a revoked transaction to steal our funds - * at least once every our_to_self_delay blocks. + * This is one of the main parameters of our security model. We (or one of our watchtowers) MUST + * be online to check for revoked transactions on-chain at least once every our_to_self_delay + * blocks (minus some margin to allow us enough time to broadcast and confirm a transaction, + * possibly with time in between to RBF the spending transaction). * * Meanwhile, asking for a too high delay, we bother peer to freeze funds for nothing in * case of an honest unilateral channel close, which implicitly decrease the economic value of * our channel. * - * Default value: BREAKDOWN_TIMEOUT (currently 144), we enforce it as a minimum at channel - * opening so you can tweak config to ask for more security, not less. + * Default value: [`BREAKDOWN_TIMEOUT`], we enforce it as a minimum at channel opening so you + * can tweak config to ask for more security, not less. */ uint16_t ChannelHandshakeConfig_get_our_to_self_delay(const struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr); /** - * Set to the amount of time we require our counterparty to wait to claim their money. + * Set to the number of blocks we require our counterparty to wait to claim their money (ie + * the number of blocks we have to punish our counterparty if they broadcast a revoked + * transaction). * - * It's one of the main parameter of our security model. We (or one of our watchtowers) MUST - * be online to check for peer having broadcast a revoked transaction to steal our funds - * at least once every our_to_self_delay blocks. + * This is one of the main parameters of our security model. We (or one of our watchtowers) MUST + * be online to check for revoked transactions on-chain at least once every our_to_self_delay + * blocks (minus some margin to allow us enough time to broadcast and confirm a transaction, + * possibly with time in between to RBF the spending transaction). * * Meanwhile, asking for a too high delay, we bother peer to freeze funds for nothing in * case of an honest unilateral channel close, which implicitly decrease the economic value of * our channel. * - * Default value: BREAKDOWN_TIMEOUT (currently 144), we enforce it as a minimum at channel - * opening so you can tweak config to ask for more security, not less. + * Default value: [`BREAKDOWN_TIMEOUT`], we enforce it as a minimum at channel opening so you + * can tweak config to ask for more security, not less. */ void ChannelHandshakeConfig_set_our_to_self_delay(struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr, uint16_t val); @@ -4861,13 +9569,25 @@ uint64_t ChannelHandshakeConfig_get_our_htlc_minimum_msat(const struct LDKChanne */ void ChannelHandshakeConfig_set_our_htlc_minimum_msat(struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr, uint64_t val); +/** + * Constructs a new ChannelHandshakeConfig given each field + */ 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); +/** + * Creates a copy of the ChannelHandshakeConfig + */ struct LDKChannelHandshakeConfig ChannelHandshakeConfig_clone(const struct LDKChannelHandshakeConfig *NONNULL_PTR orig); +/** + * Creates a "default" ChannelHandshakeConfig. See struct and individual field documentaiton for details on which values are used. + */ MUST_USE_RES struct LDKChannelHandshakeConfig ChannelHandshakeConfig_default(void); -void ChannelHandshakeLimits_free(struct LDKChannelHandshakeLimits this_ptr); +/** + * Frees any resources used by the ChannelHandshakeLimits, if is_owned is set and inner is non-NULL. + */ +void ChannelHandshakeLimits_free(struct LDKChannelHandshakeLimits this_obj); /** * Minimum allowed satoshis when a channel is funded, this is supplied by the sender and so @@ -5039,8 +9759,8 @@ void ChannelHandshakeLimits_set_force_announced_channel_preference(struct LDKCha * Not checking this value would be a security issue, as our peer would be able to set it to * max relative lock-time (a year) and we would \"lose\" money as it would be locked for a long time. * - * Default value: MAX_LOCAL_BREAKDOWN_TIMEOUT (1008), which we also enforce as a maximum value - * so you can tweak config to reduce the loss of having useless locked funds (if your peer accepts) + * Default value: 2016, which we also enforce as a maximum value so you can tweak config to + * reduce the loss of having useless locked funds (if your peer accepts) */ uint16_t ChannelHandshakeLimits_get_their_to_self_delay(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr); @@ -5050,18 +9770,30 @@ uint16_t ChannelHandshakeLimits_get_their_to_self_delay(const struct LDKChannelH * Not checking this value would be a security issue, as our peer would be able to set it to * max relative lock-time (a year) and we would \"lose\" money as it would be locked for a long time. * - * Default value: MAX_LOCAL_BREAKDOWN_TIMEOUT (1008), which we also enforce as a maximum value - * so you can tweak config to reduce the loss of having useless locked funds (if your peer accepts) + * Default value: 2016, which we also enforce as a maximum value so you can tweak config to + * reduce the loss of having useless locked funds (if your peer accepts) */ void ChannelHandshakeLimits_set_their_to_self_delay(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint16_t val); +/** + * Constructs a new ChannelHandshakeLimits given each field + */ 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); +/** + * Creates a copy of the ChannelHandshakeLimits + */ struct LDKChannelHandshakeLimits ChannelHandshakeLimits_clone(const struct LDKChannelHandshakeLimits *NONNULL_PTR orig); +/** + * Creates a "default" ChannelHandshakeLimits. See struct and individual field documentaiton for details on which values are used. + */ MUST_USE_RES struct LDKChannelHandshakeLimits ChannelHandshakeLimits_default(void); -void ChannelConfig_free(struct LDKChannelConfig this_ptr); +/** + * Frees any resources used by the ChannelConfig, if is_owned is set and inner is non-NULL. + */ +void ChannelConfig_free(struct LDKChannelConfig this_obj); /** * Amount (in millionths of a satoshi) the channel will charge per transferred satoshi. @@ -5081,6 +9813,52 @@ uint32_t ChannelConfig_get_fee_proportional_millionths(const struct LDKChannelCo */ void ChannelConfig_set_fee_proportional_millionths(struct LDKChannelConfig *NONNULL_PTR this_ptr, uint32_t val); +/** + * The difference in the CLTV value between incoming HTLCs and an outbound HTLC forwarded over + * the channel this config applies to. + * + * This is analogous to [`ChannelHandshakeConfig::our_to_self_delay`] but applies to in-flight + * HTLC balance when a channel appears on-chain whereas + * [`ChannelHandshakeConfig::our_to_self_delay`] applies to the remaining + * (non-HTLC-encumbered) balance. + * + * Thus, for HTLC-encumbered balances to be enforced on-chain when a channel is force-closed, + * we (or one of our watchtowers) MUST be online to check for broadcast of the current + * commitment transaction at least once per this many blocks (minus some margin to allow us + * enough time to broadcast and confirm a transaction, possibly with time in between to RBF + * the spending transaction). + * + * Default value: 72 (12 hours at an average of 6 blocks/hour). + * Minimum value: [`MIN_CLTV_EXPIRY_DELTA`], any values less than this will be treated as + * [`MIN_CLTV_EXPIRY_DELTA`] instead. + * + * [`MIN_CLTV_EXPIRY_DELTA`]: crate::ln::channelmanager::MIN_CLTV_EXPIRY_DELTA + */ +uint16_t ChannelConfig_get_cltv_expiry_delta(const struct LDKChannelConfig *NONNULL_PTR this_ptr); + +/** + * The difference in the CLTV value between incoming HTLCs and an outbound HTLC forwarded over + * the channel this config applies to. + * + * This is analogous to [`ChannelHandshakeConfig::our_to_self_delay`] but applies to in-flight + * HTLC balance when a channel appears on-chain whereas + * [`ChannelHandshakeConfig::our_to_self_delay`] applies to the remaining + * (non-HTLC-encumbered) balance. + * + * Thus, for HTLC-encumbered balances to be enforced on-chain when a channel is force-closed, + * we (or one of our watchtowers) MUST be online to check for broadcast of the current + * commitment transaction at least once per this many blocks (minus some margin to allow us + * enough time to broadcast and confirm a transaction, possibly with time in between to RBF + * the spending transaction). + * + * Default value: 72 (12 hours at an average of 6 blocks/hour). + * Minimum value: [`MIN_CLTV_EXPIRY_DELTA`], any values less than this will be treated as + * [`MIN_CLTV_EXPIRY_DELTA`] instead. + * + * [`MIN_CLTV_EXPIRY_DELTA`]: crate::ln::channelmanager::MIN_CLTV_EXPIRY_DELTA + */ +void ChannelConfig_set_cltv_expiry_delta(struct LDKChannelConfig *NONNULL_PTR this_ptr, uint16_t val); + /** * Set to announce the channel publicly and notify all nodes that they can route via this * channel. @@ -5141,17 +9919,35 @@ bool ChannelConfig_get_commit_upfront_shutdown_pubkey(const struct LDKChannelCon */ void ChannelConfig_set_commit_upfront_shutdown_pubkey(struct LDKChannelConfig *NONNULL_PTR this_ptr, bool val); -MUST_USE_RES struct LDKChannelConfig ChannelConfig_new(uint32_t fee_proportional_millionths_arg, bool announced_channel_arg, bool commit_upfront_shutdown_pubkey_arg); +/** + * Constructs a new ChannelConfig given each field + */ +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); +/** + * Creates a copy of the ChannelConfig + */ struct LDKChannelConfig ChannelConfig_clone(const struct LDKChannelConfig *NONNULL_PTR orig); +/** + * Creates a "default" ChannelConfig. See struct and individual field documentaiton for details on which values are used. + */ MUST_USE_RES struct LDKChannelConfig ChannelConfig_default(void); +/** + * Serialize the ChannelConfig object into a byte array which can be read by ChannelConfig_read + */ struct LDKCVec_u8Z ChannelConfig_write(const struct LDKChannelConfig *NONNULL_PTR obj); +/** + * Read a ChannelConfig from a byte array, created by ChannelConfig_write + */ struct LDKCResult_ChannelConfigDecodeErrorZ ChannelConfig_read(struct LDKu8slice ser); -void UserConfig_free(struct LDKUserConfig this_ptr); +/** + * Frees any resources used by the UserConfig, if is_owned is set and inner is non-NULL. + */ +void UserConfig_free(struct LDKUserConfig this_obj); /** * Channel config that we propose to our counterparty. @@ -5161,61 +9957,116 @@ struct LDKChannelHandshakeConfig UserConfig_get_own_channel_config(const struct /** * Channel config that we propose to our counterparty. */ -void UserConfig_set_own_channel_config(struct LDKUserConfig *NONNULL_PTR this_ptr, struct LDKChannelHandshakeConfig val); +void UserConfig_set_own_channel_config(struct LDKUserConfig *NONNULL_PTR this_ptr, struct LDKChannelHandshakeConfig val); + +/** + * Limits applied to our counterparty's proposed channel config settings. + */ +struct LDKChannelHandshakeLimits UserConfig_get_peer_channel_config_limits(const struct LDKUserConfig *NONNULL_PTR this_ptr); + +/** + * Limits applied to our counterparty's proposed channel config settings. + */ +void UserConfig_set_peer_channel_config_limits(struct LDKUserConfig *NONNULL_PTR this_ptr, struct LDKChannelHandshakeLimits val); + +/** + * Channel config which affects behavior during channel lifetime. + */ +struct LDKChannelConfig UserConfig_get_channel_options(const struct LDKUserConfig *NONNULL_PTR this_ptr); + +/** + * Channel config which affects behavior during channel lifetime. + */ +void UserConfig_set_channel_options(struct LDKUserConfig *NONNULL_PTR this_ptr, struct LDKChannelConfig val); + +/** + * Constructs a new UserConfig given each field + */ +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); + +/** + * Creates a copy of the UserConfig + */ +struct LDKUserConfig UserConfig_clone(const struct LDKUserConfig *NONNULL_PTR orig); + +/** + * Creates a "default" UserConfig. See struct and individual field documentaiton for details on which values are used. + */ +MUST_USE_RES struct LDKUserConfig UserConfig_default(void); + +/** + * Creates a copy of the AccessError + */ +enum LDKAccessError AccessError_clone(const enum LDKAccessError *NONNULL_PTR orig); + +/** + * Calls the free function if one is set + */ +void Access_free(struct LDKAccess this_ptr); + +/** + * Calls the free function if one is set + */ +void Listen_free(struct LDKListen this_ptr); + +/** + * Calls the free function if one is set + */ +void Watch_free(struct LDKWatch this_ptr); + +/** + * Calls the free function if one is set + */ +void Filter_free(struct LDKFilter this_ptr); /** - * Limits applied to our counterparty's proposed channel config settings. + * Frees any resources used by the WatchedOutput, if is_owned is set and inner is non-NULL. */ -struct LDKChannelHandshakeLimits UserConfig_get_peer_channel_config_limits(const struct LDKUserConfig *NONNULL_PTR this_ptr); +void WatchedOutput_free(struct LDKWatchedOutput this_obj); /** - * Limits applied to our counterparty's proposed channel config settings. + * First block where the transaction output may have been spent. */ -void UserConfig_set_peer_channel_config_limits(struct LDKUserConfig *NONNULL_PTR this_ptr, struct LDKChannelHandshakeLimits val); +struct LDKThirtyTwoBytes WatchedOutput_get_block_hash(const struct LDKWatchedOutput *NONNULL_PTR this_ptr); /** - * Channel config which affects behavior during channel lifetime. + * First block where the transaction output may have been spent. */ -struct LDKChannelConfig UserConfig_get_channel_options(const struct LDKUserConfig *NONNULL_PTR this_ptr); +void WatchedOutput_set_block_hash(struct LDKWatchedOutput *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val); /** - * Channel config which affects behavior during channel lifetime. + * Outpoint identifying the transaction output. */ -void UserConfig_set_channel_options(struct LDKUserConfig *NONNULL_PTR this_ptr, struct LDKChannelConfig val); - -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); - -struct LDKUserConfig UserConfig_clone(const struct LDKUserConfig *NONNULL_PTR orig); - -MUST_USE_RES struct LDKUserConfig UserConfig_default(void); - -enum LDKAccessError AccessError_clone(const enum LDKAccessError *NONNULL_PTR orig); +struct LDKOutPoint WatchedOutput_get_outpoint(const struct LDKWatchedOutput *NONNULL_PTR this_ptr); /** - * Calls the free function if one is set + * Outpoint identifying the transaction output. */ -void Access_free(struct LDKAccess this_ptr); +void WatchedOutput_set_outpoint(struct LDKWatchedOutput *NONNULL_PTR this_ptr, struct LDKOutPoint val); /** - * Calls the free function if one is set + * Spending condition of the transaction output. */ -void Listen_free(struct LDKListen this_ptr); +struct LDKu8slice WatchedOutput_get_script_pubkey(const struct LDKWatchedOutput *NONNULL_PTR this_ptr); /** - * Calls the free function if one is set + * Spending condition of the transaction output. */ -void Watch_free(struct LDKWatch this_ptr); +void WatchedOutput_set_script_pubkey(struct LDKWatchedOutput *NONNULL_PTR this_ptr, struct LDKCVec_u8Z val); /** - * Calls the free function if one is set + * Constructs a new WatchedOutput given each field */ -void Filter_free(struct LDKFilter this_ptr); +MUST_USE_RES struct LDKWatchedOutput WatchedOutput_new(struct LDKThirtyTwoBytes block_hash_arg, struct LDKOutPoint outpoint_arg, struct LDKCVec_u8Z script_pubkey_arg); /** * Calls the free function if one is set */ void BroadcasterInterface_free(struct LDKBroadcasterInterface this_ptr); +/** + * Creates a copy of the ConfirmationTarget + */ enum LDKConfirmationTarget ConfirmationTarget_clone(const enum LDKConfirmationTarget *NONNULL_PTR orig); /** @@ -5223,7 +10074,10 @@ enum LDKConfirmationTarget ConfirmationTarget_clone(const enum LDKConfirmationTa */ void FeeEstimator_free(struct LDKFeeEstimator this_ptr); -void ChainMonitor_free(struct LDKChainMonitor this_ptr); +/** + * Frees any resources used by the ChainMonitor, if is_owned is set and inner is non-NULL. + */ +void ChainMonitor_free(struct LDKChainMonitor this_obj); /** * Dispatches to per-channel monitors, which are responsible for updating their on-chain view @@ -5235,10 +10089,6 @@ void ChainMonitor_free(struct LDKChainMonitor this_ptr); * calls must not exclude any transactions matching the new outputs nor any in-block * descendants of such transactions. It is not necessary to re-fetch the block to obtain * updated `txdata`. - * - * [`ChannelMonitor::block_connected`]: ../channelmonitor/struct.ChannelMonitor.html#method.block_connected - * [`chain::Watch::release_pending_monitor_events`]: ../trait.Watch.html#tymethod.release_pending_monitor_events - * [`chain::Filter`]: ../trait.Filter.html */ void ChainMonitor_block_connected(const struct LDKChainMonitor *NONNULL_PTR this_arg, const uint8_t (*header)[80], struct LDKCVec_C2Tuple_usizeTransactionZZ txdata, uint32_t height); @@ -5246,8 +10096,6 @@ void ChainMonitor_block_connected(const struct LDKChainMonitor *NONNULL_PTR this * Dispatches to per-channel monitors, which are responsible for updating their on-chain view * of a channel based on the disconnected block. See [`ChannelMonitor::block_disconnected`] for * details. - * - * [`ChannelMonitor::block_disconnected`]: ../channelmonitor/struct.ChannelMonitor.html#method.block_disconnected */ void ChainMonitor_block_disconnected(const struct LDKChainMonitor *NONNULL_PTR this_arg, const uint8_t (*header)[80], uint32_t disconnected_height); @@ -5259,16 +10107,25 @@ void ChainMonitor_block_disconnected(const struct LDKChainMonitor *NONNULL_PTR t * pre-filter blocks or only fetch blocks matching a compact filter. Otherwise, clients may * always need to fetch full blocks absent another means for determining which blocks contain * transactions relevant to the watched channels. - * - * [`chain::Filter`]: ../trait.Filter.html */ MUST_USE_RES struct LDKChainMonitor ChainMonitor_new(struct LDKFilter *chain_source, struct LDKBroadcasterInterface broadcaster, struct LDKLogger logger, struct LDKFeeEstimator feeest, struct LDKPersist persister); +/** + * Constructs a new Watch which calls the relevant methods on this_arg. + * This copies the `inner` pointer in this_arg and thus the returned Watch must be freed before this_arg is + */ struct LDKWatch ChainMonitor_as_Watch(const struct LDKChainMonitor *NONNULL_PTR this_arg); +/** + * Constructs a new EventsProvider which calls the relevant methods on this_arg. + * This copies the `inner` pointer in this_arg and thus the returned EventsProvider must be freed before this_arg is + */ struct LDKEventsProvider ChainMonitor_as_EventsProvider(const struct LDKChainMonitor *NONNULL_PTR this_arg); -void ChannelMonitorUpdate_free(struct LDKChannelMonitorUpdate this_ptr); +/** + * Frees any resources used by the ChannelMonitorUpdate, if is_owned is set and inner is non-NULL. + */ +void ChannelMonitorUpdate_free(struct LDKChannelMonitorUpdate this_obj); /** * The sequence number of this update. Updates *must* be replayed in-order according to this @@ -5282,8 +10139,6 @@ void ChannelMonitorUpdate_free(struct LDKChannelMonitorUpdate this_ptr); * The only instance where update_id values are not strictly increasing is the case where we * allow post-force-close updates with a special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. See * its docs for more details. - * - * [`CLOSED_CHANNEL_UPDATE_ID`]: constant.CLOSED_CHANNEL_UPDATE_ID.html */ uint64_t ChannelMonitorUpdate_get_update_id(const struct LDKChannelMonitorUpdate *NONNULL_PTR this_ptr); @@ -5299,37 +10154,77 @@ uint64_t ChannelMonitorUpdate_get_update_id(const struct LDKChannelMonitorUpdate * The only instance where update_id values are not strictly increasing is the case where we * allow post-force-close updates with a special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. See * its docs for more details. - * - * [`CLOSED_CHANNEL_UPDATE_ID`]: constant.CLOSED_CHANNEL_UPDATE_ID.html */ void ChannelMonitorUpdate_set_update_id(struct LDKChannelMonitorUpdate *NONNULL_PTR this_ptr, uint64_t val); +/** + * Creates a copy of the ChannelMonitorUpdate + */ struct LDKChannelMonitorUpdate ChannelMonitorUpdate_clone(const struct LDKChannelMonitorUpdate *NONNULL_PTR orig); +/** + * Serialize the ChannelMonitorUpdate object into a byte array which can be read by ChannelMonitorUpdate_read + */ struct LDKCVec_u8Z ChannelMonitorUpdate_write(const struct LDKChannelMonitorUpdate *NONNULL_PTR obj); +/** + * Read a ChannelMonitorUpdate from a byte array, created by ChannelMonitorUpdate_write + */ struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ ChannelMonitorUpdate_read(struct LDKu8slice ser); +/** + * Creates a copy of the ChannelMonitorUpdateErr + */ enum LDKChannelMonitorUpdateErr ChannelMonitorUpdateErr_clone(const enum LDKChannelMonitorUpdateErr *NONNULL_PTR orig); -void MonitorUpdateError_free(struct LDKMonitorUpdateError this_ptr); +/** + * Frees any resources used by the MonitorUpdateError, if is_owned is set and inner is non-NULL. + */ +void MonitorUpdateError_free(struct LDKMonitorUpdateError this_obj); +/** + * Creates a copy of the MonitorUpdateError + */ struct LDKMonitorUpdateError MonitorUpdateError_clone(const struct LDKMonitorUpdateError *NONNULL_PTR orig); +/** + * Frees any resources used by the MonitorEvent + */ void MonitorEvent_free(struct LDKMonitorEvent this_ptr); +/** + * Creates a copy of the MonitorEvent + */ struct LDKMonitorEvent MonitorEvent_clone(const struct LDKMonitorEvent *NONNULL_PTR orig); -void HTLCUpdate_free(struct LDKHTLCUpdate this_ptr); +/** + * Frees any resources used by the HTLCUpdate, if is_owned is set and inner is non-NULL. + */ +void HTLCUpdate_free(struct LDKHTLCUpdate this_obj); +/** + * Creates a copy of the HTLCUpdate + */ struct LDKHTLCUpdate HTLCUpdate_clone(const struct LDKHTLCUpdate *NONNULL_PTR orig); +/** + * Serialize the HTLCUpdate object into a byte array which can be read by HTLCUpdate_read + */ struct LDKCVec_u8Z HTLCUpdate_write(const struct LDKHTLCUpdate *NONNULL_PTR obj); +/** + * Read a HTLCUpdate from a byte array, created by HTLCUpdate_write + */ struct LDKCResult_HTLCUpdateDecodeErrorZ HTLCUpdate_read(struct LDKu8slice ser); -void ChannelMonitor_free(struct LDKChannelMonitor this_ptr); +/** + * Frees any resources used by the ChannelMonitor, if is_owned is set and inner is non-NULL. + */ +void ChannelMonitor_free(struct LDKChannelMonitor this_obj); +/** + * Serialize the ChannelMonitor object into a byte array which can be read by ChannelMonitor_read + */ struct LDKCVec_u8Z ChannelMonitor_write(const struct LDKChannelMonitor *NONNULL_PTR obj); /** @@ -5351,11 +10246,22 @@ MUST_USE_RES uint64_t ChannelMonitor_get_latest_update_id(const struct LDKChanne */ MUST_USE_RES struct LDKC2Tuple_OutPointScriptZ ChannelMonitor_get_funding_txo(const struct LDKChannelMonitor *NONNULL_PTR this_arg); +/** + * Gets a list of txids, with their output scripts (in the order they appear in the + * transaction), which we must learn about spends of via block_connected(). + */ +MUST_USE_RES struct LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ ChannelMonitor_get_outputs_to_watch(const struct LDKChannelMonitor *NONNULL_PTR this_arg); + +/** + * Loads the funding txo and outputs to watch into the given `chain::Filter` by repeatedly + * calling `chain::Filter::register_output` and `chain::Filter::register_tx` until all outputs + * have been registered. + */ +void ChannelMonitor_load_outputs_to_watch(const struct LDKChannelMonitor *NONNULL_PTR this_arg, const struct LDKFilter *NONNULL_PTR filter); + /** * Get the list of HTLCs who's status has been updated on chain. This should be called by * ChannelManager via [`chain::Watch::release_pending_monitor_events`]. - * - * [`chain::Watch::release_pending_monitor_events`]: ../trait.Watch.html#tymethod.release_pending_monitor_events */ MUST_USE_RES struct LDKCVec_MonitorEventZ ChannelMonitor_get_and_clear_pending_monitor_events(const struct LDKChannelMonitor *NONNULL_PTR this_arg); @@ -5408,9 +10314,15 @@ void ChannelMonitor_block_disconnected(const struct LDKChannelMonitor *NONNULL_P */ void Persist_free(struct LDKPersist this_ptr); +/** + * Read a C2Tuple_BlockHashChannelMonitorZ from a byte array, created by C2Tuple_BlockHashChannelMonitorZ_write + */ struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ C2Tuple_BlockHashChannelMonitorZ_read(struct LDKu8slice ser, const struct LDKKeysInterface *NONNULL_PTR arg); -void OutPoint_free(struct LDKOutPoint this_ptr); +/** + * Frees any resources used by the OutPoint, if is_owned is set and inner is non-NULL. + */ +void OutPoint_free(struct LDKOutPoint this_obj); /** * The referenced transaction's txid. @@ -5432,8 +10344,14 @@ uint16_t OutPoint_get_index(const struct LDKOutPoint *NONNULL_PTR this_ptr); */ void OutPoint_set_index(struct LDKOutPoint *NONNULL_PTR this_ptr, uint16_t val); +/** + * Constructs a new OutPoint given each field + */ MUST_USE_RES struct LDKOutPoint OutPoint_new(struct LDKThirtyTwoBytes txid_arg, uint16_t index_arg); +/** + * Creates a copy of the OutPoint + */ struct LDKOutPoint OutPoint_clone(const struct LDKOutPoint *NONNULL_PTR orig); /** @@ -5441,11 +10359,20 @@ struct LDKOutPoint OutPoint_clone(const struct LDKOutPoint *NONNULL_PTR orig); */ MUST_USE_RES struct LDKThirtyTwoBytes OutPoint_to_channel_id(const struct LDKOutPoint *NONNULL_PTR this_arg); +/** + * Serialize the OutPoint object into a byte array which can be read by OutPoint_read + */ struct LDKCVec_u8Z OutPoint_write(const struct LDKOutPoint *NONNULL_PTR obj); +/** + * Read a OutPoint from a byte array, created by OutPoint_write + */ struct LDKCResult_OutPointDecodeErrorZ OutPoint_read(struct LDKu8slice ser); -void DelayedPaymentOutputDescriptor_free(struct LDKDelayedPaymentOutputDescriptor this_ptr); +/** + * Frees any resources used by the DelayedPaymentOutputDescriptor, if is_owned is set and inner is non-NULL. + */ +void DelayedPaymentOutputDescriptor_free(struct LDKDelayedPaymentOutputDescriptor this_obj); /** * The outpoint which is spendable @@ -5520,11 +10447,20 @@ uint64_t DelayedPaymentOutputDescriptor_get_channel_value_satoshis(const struct */ void DelayedPaymentOutputDescriptor_set_channel_value_satoshis(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, uint64_t val); +/** + * Constructs a new DelayedPaymentOutputDescriptor given each field + */ 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); +/** + * Creates a copy of the DelayedPaymentOutputDescriptor + */ struct LDKDelayedPaymentOutputDescriptor DelayedPaymentOutputDescriptor_clone(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR orig); -void StaticPaymentOutputDescriptor_free(struct LDKStaticPaymentOutputDescriptor this_ptr); +/** + * Frees any resources used by the StaticPaymentOutputDescriptor, if is_owned is set and inner is non-NULL. + */ +void StaticPaymentOutputDescriptor_free(struct LDKStaticPaymentOutputDescriptor this_obj); /** * The outpoint which is spendable @@ -5565,18 +10501,39 @@ uint64_t StaticPaymentOutputDescriptor_get_channel_value_satoshis(const struct L */ void StaticPaymentOutputDescriptor_set_channel_value_satoshis(struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr, uint64_t val); +/** + * Constructs a new StaticPaymentOutputDescriptor given each field + */ 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); +/** + * Creates a copy of the StaticPaymentOutputDescriptor + */ struct LDKStaticPaymentOutputDescriptor StaticPaymentOutputDescriptor_clone(const struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR orig); +/** + * Frees any resources used by the SpendableOutputDescriptor + */ void SpendableOutputDescriptor_free(struct LDKSpendableOutputDescriptor this_ptr); +/** + * Creates a copy of the SpendableOutputDescriptor + */ struct LDKSpendableOutputDescriptor SpendableOutputDescriptor_clone(const struct LDKSpendableOutputDescriptor *NONNULL_PTR orig); +/** + * Serialize the SpendableOutputDescriptor object into a byte array which can be read by SpendableOutputDescriptor_read + */ struct LDKCVec_u8Z SpendableOutputDescriptor_write(const struct LDKSpendableOutputDescriptor *NONNULL_PTR obj); +/** + * Read a SpendableOutputDescriptor from a byte array, created by SpendableOutputDescriptor_write + */ struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ SpendableOutputDescriptor_read(struct LDKu8slice ser); +/** + * Creates a copy of a Sign + */ struct LDKSign Sign_clone(const struct LDKSign *NONNULL_PTR orig); /** @@ -5589,7 +10546,10 @@ void Sign_free(struct LDKSign this_ptr); */ void KeysInterface_free(struct LDKKeysInterface this_ptr); -void InMemorySigner_free(struct LDKInMemorySigner this_ptr); +/** + * Frees any resources used by the InMemorySigner, if is_owned is set and inner is non-NULL. + */ +void InMemorySigner_free(struct LDKInMemorySigner this_obj); /** * Private key of anchor tx @@ -5651,6 +10611,9 @@ const uint8_t (*InMemorySigner_get_commitment_seed(const struct LDKInMemorySigne */ void InMemorySigner_set_commitment_seed(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val); +/** + * Creates a copy of the InMemorySigner + */ struct LDKInMemorySigner InMemorySigner_clone(const struct LDKInMemorySigner *NONNULL_PTR orig); /** @@ -5719,13 +10682,26 @@ MUST_USE_RES struct LDKCResult_CVec_CVec_u8ZZNoneZ InMemorySigner_sign_counterpa */ 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); +/** + * Constructs a new Sign which calls the relevant methods on this_arg. + * This copies the `inner` pointer in this_arg and thus the returned Sign must be freed before this_arg is + */ struct LDKSign InMemorySigner_as_Sign(const struct LDKInMemorySigner *NONNULL_PTR this_arg); +/** + * Serialize the InMemorySigner object into a byte array which can be read by InMemorySigner_read + */ struct LDKCVec_u8Z InMemorySigner_write(const struct LDKInMemorySigner *NONNULL_PTR obj); +/** + * Read a InMemorySigner from a byte array, created by InMemorySigner_write + */ struct LDKCResult_InMemorySignerDecodeErrorZ InMemorySigner_read(struct LDKu8slice ser); -void KeysManager_free(struct LDKKeysManager this_ptr); +/** + * Frees any resources used by the KeysManager, if is_owned is set and inner is non-NULL. + */ +void KeysManager_free(struct LDKKeysManager this_obj); /** * Constructs a KeysManager from a 32-byte seed. If the seed is in some way biased (eg your @@ -5774,11 +10750,21 @@ MUST_USE_RES struct LDKInMemorySigner KeysManager_derive_channel_keys(const stru */ 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); +/** + * Constructs a new KeysInterface which calls the relevant methods on this_arg. + * This copies the `inner` pointer in this_arg and thus the returned KeysInterface must be freed before this_arg is + */ struct LDKKeysInterface KeysManager_as_KeysInterface(const struct LDKKeysManager *NONNULL_PTR this_arg); -void ChannelManager_free(struct LDKChannelManager this_ptr); +/** + * Frees any resources used by the ChannelManager, if is_owned is set and inner is non-NULL. + */ +void ChannelManager_free(struct LDKChannelManager this_obj); -void ChainParameters_free(struct LDKChainParameters this_ptr); +/** + * Frees any resources used by the ChainParameters, if is_owned is set and inner is non-NULL. + */ +void ChainParameters_free(struct LDKChainParameters this_obj); /** * The network for determining the `chain_hash` in Lightning messages. @@ -5814,9 +10800,15 @@ uintptr_t ChainParameters_get_latest_height(const struct LDKChainParameters *NON */ void ChainParameters_set_latest_height(struct LDKChainParameters *NONNULL_PTR this_ptr, uintptr_t val); +/** + * Constructs a new ChainParameters given each field + */ MUST_USE_RES struct LDKChainParameters ChainParameters_new(enum LDKNetwork network_arg, struct LDKThirtyTwoBytes latest_hash_arg, uintptr_t latest_height_arg); -void ChannelDetails_free(struct LDKChannelDetails this_ptr); +/** + * Frees any resources used by the ChannelDetails, if is_owned is set and inner is non-NULL. + */ +void ChannelDetails_free(struct LDKChannelDetails this_obj); /** * The channel's ID (prior to funding transaction generation, this is a random 32 bytes, @@ -5834,6 +10826,18 @@ const uint8_t (*ChannelDetails_get_channel_id(const struct LDKChannelDetails *NO */ void ChannelDetails_set_channel_id(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val); +/** + * The position of the funding transaction in the chain. None if the funding transaction has + * not yet been confirmed and the channel fully opened. + */ +struct LDKCOption_u64Z ChannelDetails_get_short_channel_id(const struct LDKChannelDetails *NONNULL_PTR this_ptr); + +/** + * The position of the funding transaction in the chain. None if the funding transaction has + * not yet been confirmed and the channel fully opened. + */ +void ChannelDetails_set_short_channel_id(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val); + /** * The node_id of our counterparty */ @@ -5924,10 +10928,19 @@ bool ChannelDetails_get_is_live(const struct LDKChannelDetails *NONNULL_PTR this */ void ChannelDetails_set_is_live(struct LDKChannelDetails *NONNULL_PTR this_ptr, bool val); +/** + * Creates a copy of the ChannelDetails + */ struct LDKChannelDetails ChannelDetails_clone(const struct LDKChannelDetails *NONNULL_PTR orig); +/** + * Frees any resources used by the PaymentSendFailure + */ void PaymentSendFailure_free(struct LDKPaymentSendFailure this_ptr); +/** + * Creates a copy of the PaymentSendFailure + */ struct LDKPaymentSendFailure PaymentSendFailure_clone(const struct LDKPaymentSendFailure *NONNULL_PTR orig); /** @@ -6147,10 +11160,22 @@ MUST_USE_RES struct LDKPublicKey ChannelManager_get_our_node_id(const struct LDK */ 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); +/** + * Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg. + * This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is + */ struct LDKMessageSendEventsProvider ChannelManager_as_MessageSendEventsProvider(const struct LDKChannelManager *NONNULL_PTR this_arg); +/** + * Constructs a new EventsProvider which calls the relevant methods on this_arg. + * This copies the `inner` pointer in this_arg and thus the returned EventsProvider must be freed before this_arg is + */ struct LDKEventsProvider ChannelManager_as_EventsProvider(const struct LDKChannelManager *NONNULL_PTR this_arg); +/** + * Constructs a new Listen which calls the relevant methods on this_arg. + * This copies the `inner` pointer in this_arg and thus the returned Listen must be freed before this_arg is + */ struct LDKListen ChannelManager_as_Listen(const struct LDKChannelManager *NONNULL_PTR this_arg); /** @@ -6173,11 +11198,21 @@ void ChannelManager_block_disconnected(const struct LDKChannelManager *NONNULL_P */ void ChannelManager_await_persistable_update(const struct LDKChannelManager *NONNULL_PTR this_arg); +/** + * Constructs a new ChannelMessageHandler which calls the relevant methods on this_arg. + * This copies the `inner` pointer in this_arg and thus the returned ChannelMessageHandler must be freed before this_arg is + */ struct LDKChannelMessageHandler ChannelManager_as_ChannelMessageHandler(const struct LDKChannelManager *NONNULL_PTR this_arg); +/** + * Serialize the ChannelManager object into a byte array which can be read by ChannelManager_read + */ struct LDKCVec_u8Z ChannelManager_write(const struct LDKChannelManager *NONNULL_PTR obj); -void ChannelManagerReadArgs_free(struct LDKChannelManagerReadArgs this_ptr); +/** + * Frees any resources used by the ChannelManagerReadArgs, if is_owned is set and inner is non-NULL. + */ +void ChannelManagerReadArgs_free(struct LDKChannelManagerReadArgs this_obj); /** * The keys provider which will give us relevant keys. Some keys will be loaded during @@ -6270,13 +11305,25 @@ void ChannelManagerReadArgs_set_default_config(struct LDKChannelManagerReadArgs */ 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); +/** + * Read a C2Tuple_BlockHashChannelManagerZ from a byte array, created by C2Tuple_BlockHashChannelManagerZ_write + */ struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ C2Tuple_BlockHashChannelManagerZ_read(struct LDKu8slice ser, struct LDKChannelManagerReadArgs arg); -void DecodeError_free(struct LDKDecodeError this_ptr); +/** + * Frees any resources used by the DecodeError, if is_owned is set and inner is non-NULL. + */ +void DecodeError_free(struct LDKDecodeError this_obj); +/** + * Creates a copy of the DecodeError + */ struct LDKDecodeError DecodeError_clone(const struct LDKDecodeError *NONNULL_PTR orig); -void Init_free(struct LDKInit this_ptr); +/** + * Frees any resources used by the Init, if is_owned is set and inner is non-NULL. + */ +void Init_free(struct LDKInit this_obj); /** * The relevant features which the sender supports @@ -6288,11 +11335,20 @@ struct LDKInitFeatures Init_get_features(const struct LDKInit *NONNULL_PTR this_ */ void Init_set_features(struct LDKInit *NONNULL_PTR this_ptr, struct LDKInitFeatures val); +/** + * Constructs a new Init given each field + */ MUST_USE_RES struct LDKInit Init_new(struct LDKInitFeatures features_arg); +/** + * Creates a copy of the Init + */ struct LDKInit Init_clone(const struct LDKInit *NONNULL_PTR orig); -void ErrorMessage_free(struct LDKErrorMessage this_ptr); +/** + * Frees any resources used by the ErrorMessage, if is_owned is set and inner is non-NULL. + */ +void ErrorMessage_free(struct LDKErrorMessage this_obj); /** * The channel ID involved in the error @@ -6320,11 +11376,20 @@ struct LDKStr ErrorMessage_get_data(const struct LDKErrorMessage *NONNULL_PTR th */ void ErrorMessage_set_data(struct LDKErrorMessage *NONNULL_PTR this_ptr, struct LDKCVec_u8Z val); +/** + * Constructs a new ErrorMessage given each field + */ MUST_USE_RES struct LDKErrorMessage ErrorMessage_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKCVec_u8Z data_arg); +/** + * Creates a copy of the ErrorMessage + */ struct LDKErrorMessage ErrorMessage_clone(const struct LDKErrorMessage *NONNULL_PTR orig); -void Ping_free(struct LDKPing this_ptr); +/** + * Frees any resources used by the Ping, if is_owned is set and inner is non-NULL. + */ +void Ping_free(struct LDKPing this_obj); /** * The desired response length @@ -6348,11 +11413,20 @@ uint16_t Ping_get_byteslen(const struct LDKPing *NONNULL_PTR this_ptr); */ void Ping_set_byteslen(struct LDKPing *NONNULL_PTR this_ptr, uint16_t val); +/** + * Constructs a new Ping given each field + */ MUST_USE_RES struct LDKPing Ping_new(uint16_t ponglen_arg, uint16_t byteslen_arg); +/** + * Creates a copy of the Ping + */ struct LDKPing Ping_clone(const struct LDKPing *NONNULL_PTR orig); -void Pong_free(struct LDKPong this_ptr); +/** + * Frees any resources used by the Pong, if is_owned is set and inner is non-NULL. + */ +void Pong_free(struct LDKPong this_obj); /** * The pong packet size. @@ -6366,11 +11440,20 @@ uint16_t Pong_get_byteslen(const struct LDKPong *NONNULL_PTR this_ptr); */ void Pong_set_byteslen(struct LDKPong *NONNULL_PTR this_ptr, uint16_t val); +/** + * Constructs a new Pong given each field + */ MUST_USE_RES struct LDKPong Pong_new(uint16_t byteslen_arg); +/** + * Creates a copy of the Pong + */ struct LDKPong Pong_clone(const struct LDKPong *NONNULL_PTR orig); -void OpenChannel_free(struct LDKOpenChannel this_ptr); +/** + * Frees any resources used by the OpenChannel, if is_owned is set and inner is non-NULL. + */ +void OpenChannel_free(struct LDKOpenChannel this_obj); /** * The genesis hash of the blockchain where the channel is to be opened @@ -6552,9 +11635,15 @@ uint8_t OpenChannel_get_channel_flags(const struct LDKOpenChannel *NONNULL_PTR t */ void OpenChannel_set_channel_flags(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint8_t val); +/** + * Creates a copy of the OpenChannel + */ struct LDKOpenChannel OpenChannel_clone(const struct LDKOpenChannel *NONNULL_PTR orig); -void AcceptChannel_free(struct LDKAcceptChannel this_ptr); +/** + * Frees any resources used by the AcceptChannel, if is_owned is set and inner is non-NULL. + */ +void AcceptChannel_free(struct LDKAcceptChannel this_obj); /** * A temporary channel ID, until the funding outpoint is announced @@ -6696,9 +11785,15 @@ struct LDKPublicKey AcceptChannel_get_first_per_commitment_point(const struct LD */ void AcceptChannel_set_first_per_commitment_point(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val); +/** + * Creates a copy of the AcceptChannel + */ struct LDKAcceptChannel AcceptChannel_clone(const struct LDKAcceptChannel *NONNULL_PTR orig); -void FundingCreated_free(struct LDKFundingCreated this_ptr); +/** + * Frees any resources used by the FundingCreated, if is_owned is set and inner is non-NULL. + */ +void FundingCreated_free(struct LDKFundingCreated this_obj); /** * A temporary channel ID, until the funding is established @@ -6740,11 +11835,20 @@ struct LDKSignature FundingCreated_get_signature(const struct LDKFundingCreated */ void FundingCreated_set_signature(struct LDKFundingCreated *NONNULL_PTR this_ptr, struct LDKSignature val); +/** + * Constructs a new FundingCreated given each field + */ 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); +/** + * Creates a copy of the FundingCreated + */ struct LDKFundingCreated FundingCreated_clone(const struct LDKFundingCreated *NONNULL_PTR orig); -void FundingSigned_free(struct LDKFundingSigned this_ptr); +/** + * Frees any resources used by the FundingSigned, if is_owned is set and inner is non-NULL. + */ +void FundingSigned_free(struct LDKFundingSigned this_obj); /** * The channel ID @@ -6766,11 +11870,20 @@ struct LDKSignature FundingSigned_get_signature(const struct LDKFundingSigned *N */ void FundingSigned_set_signature(struct LDKFundingSigned *NONNULL_PTR this_ptr, struct LDKSignature val); +/** + * Constructs a new FundingSigned given each field + */ MUST_USE_RES struct LDKFundingSigned FundingSigned_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKSignature signature_arg); +/** + * Creates a copy of the FundingSigned + */ struct LDKFundingSigned FundingSigned_clone(const struct LDKFundingSigned *NONNULL_PTR orig); -void FundingLocked_free(struct LDKFundingLocked this_ptr); +/** + * Frees any resources used by the FundingLocked, if is_owned is set and inner is non-NULL. + */ +void FundingLocked_free(struct LDKFundingLocked this_obj); /** * The channel ID @@ -6792,11 +11905,20 @@ struct LDKPublicKey FundingLocked_get_next_per_commitment_point(const struct LDK */ void FundingLocked_set_next_per_commitment_point(struct LDKFundingLocked *NONNULL_PTR this_ptr, struct LDKPublicKey val); +/** + * Constructs a new FundingLocked given each field + */ MUST_USE_RES struct LDKFundingLocked FundingLocked_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKPublicKey next_per_commitment_point_arg); +/** + * Creates a copy of the FundingLocked + */ struct LDKFundingLocked FundingLocked_clone(const struct LDKFundingLocked *NONNULL_PTR orig); -void Shutdown_free(struct LDKShutdown this_ptr); +/** + * Frees any resources used by the Shutdown, if is_owned is set and inner is non-NULL. + */ +void Shutdown_free(struct LDKShutdown this_obj); /** * The channel ID @@ -6820,11 +11942,20 @@ struct LDKu8slice Shutdown_get_scriptpubkey(const struct LDKShutdown *NONNULL_PT */ void Shutdown_set_scriptpubkey(struct LDKShutdown *NONNULL_PTR this_ptr, struct LDKCVec_u8Z val); +/** + * Constructs a new Shutdown given each field + */ MUST_USE_RES struct LDKShutdown Shutdown_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKCVec_u8Z scriptpubkey_arg); +/** + * Creates a copy of the Shutdown + */ struct LDKShutdown Shutdown_clone(const struct LDKShutdown *NONNULL_PTR orig); -void ClosingSigned_free(struct LDKClosingSigned this_ptr); +/** + * Frees any resources used by the ClosingSigned, if is_owned is set and inner is non-NULL. + */ +void ClosingSigned_free(struct LDKClosingSigned this_obj); /** * The channel ID @@ -6856,11 +11987,20 @@ struct LDKSignature ClosingSigned_get_signature(const struct LDKClosingSigned *N */ void ClosingSigned_set_signature(struct LDKClosingSigned *NONNULL_PTR this_ptr, struct LDKSignature val); +/** + * Constructs a new ClosingSigned given each field + */ MUST_USE_RES struct LDKClosingSigned ClosingSigned_new(struct LDKThirtyTwoBytes channel_id_arg, uint64_t fee_satoshis_arg, struct LDKSignature signature_arg); +/** + * Creates a copy of the ClosingSigned + */ struct LDKClosingSigned ClosingSigned_clone(const struct LDKClosingSigned *NONNULL_PTR orig); -void UpdateAddHTLC_free(struct LDKUpdateAddHTLC this_ptr); +/** + * Frees any resources used by the UpdateAddHTLC, if is_owned is set and inner is non-NULL. + */ +void UpdateAddHTLC_free(struct LDKUpdateAddHTLC this_obj); /** * The channel ID @@ -6912,9 +12052,15 @@ uint32_t UpdateAddHTLC_get_cltv_expiry(const struct LDKUpdateAddHTLC *NONNULL_PT */ void UpdateAddHTLC_set_cltv_expiry(struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr, uint32_t val); +/** + * Creates a copy of the UpdateAddHTLC + */ struct LDKUpdateAddHTLC UpdateAddHTLC_clone(const struct LDKUpdateAddHTLC *NONNULL_PTR orig); -void UpdateFulfillHTLC_free(struct LDKUpdateFulfillHTLC this_ptr); +/** + * Frees any resources used by the UpdateFulfillHTLC, if is_owned is set and inner is non-NULL. + */ +void UpdateFulfillHTLC_free(struct LDKUpdateFulfillHTLC this_obj); /** * The channel ID @@ -6946,11 +12092,20 @@ const uint8_t (*UpdateFulfillHTLC_get_payment_preimage(const struct LDKUpdateFul */ void UpdateFulfillHTLC_set_payment_preimage(struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val); +/** + * Constructs a new UpdateFulfillHTLC given each field + */ MUST_USE_RES struct LDKUpdateFulfillHTLC UpdateFulfillHTLC_new(struct LDKThirtyTwoBytes channel_id_arg, uint64_t htlc_id_arg, struct LDKThirtyTwoBytes payment_preimage_arg); +/** + * Creates a copy of the UpdateFulfillHTLC + */ struct LDKUpdateFulfillHTLC UpdateFulfillHTLC_clone(const struct LDKUpdateFulfillHTLC *NONNULL_PTR orig); -void UpdateFailHTLC_free(struct LDKUpdateFailHTLC this_ptr); +/** + * Frees any resources used by the UpdateFailHTLC, if is_owned is set and inner is non-NULL. + */ +void UpdateFailHTLC_free(struct LDKUpdateFailHTLC this_obj); /** * The channel ID @@ -6972,9 +12127,15 @@ uint64_t UpdateFailHTLC_get_htlc_id(const struct LDKUpdateFailHTLC *NONNULL_PTR */ void UpdateFailHTLC_set_htlc_id(struct LDKUpdateFailHTLC *NONNULL_PTR this_ptr, uint64_t val); +/** + * Creates a copy of the UpdateFailHTLC + */ struct LDKUpdateFailHTLC UpdateFailHTLC_clone(const struct LDKUpdateFailHTLC *NONNULL_PTR orig); -void UpdateFailMalformedHTLC_free(struct LDKUpdateFailMalformedHTLC this_ptr); +/** + * Frees any resources used by the UpdateFailMalformedHTLC, if is_owned is set and inner is non-NULL. + */ +void UpdateFailMalformedHTLC_free(struct LDKUpdateFailMalformedHTLC this_obj); /** * The channel ID @@ -7006,9 +12167,15 @@ uint16_t UpdateFailMalformedHTLC_get_failure_code(const struct LDKUpdateFailMalf */ void UpdateFailMalformedHTLC_set_failure_code(struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr, uint16_t val); +/** + * Creates a copy of the UpdateFailMalformedHTLC + */ struct LDKUpdateFailMalformedHTLC UpdateFailMalformedHTLC_clone(const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR orig); -void CommitmentSigned_free(struct LDKCommitmentSigned this_ptr); +/** + * Frees any resources used by the CommitmentSigned, if is_owned is set and inner is non-NULL. + */ +void CommitmentSigned_free(struct LDKCommitmentSigned this_obj); /** * The channel ID @@ -7035,11 +12202,20 @@ void CommitmentSigned_set_signature(struct LDKCommitmentSigned *NONNULL_PTR this */ void CommitmentSigned_set_htlc_signatures(struct LDKCommitmentSigned *NONNULL_PTR this_ptr, struct LDKCVec_SignatureZ val); +/** + * Constructs a new CommitmentSigned given each field + */ MUST_USE_RES struct LDKCommitmentSigned CommitmentSigned_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKSignature signature_arg, struct LDKCVec_SignatureZ htlc_signatures_arg); +/** + * Creates a copy of the CommitmentSigned + */ struct LDKCommitmentSigned CommitmentSigned_clone(const struct LDKCommitmentSigned *NONNULL_PTR orig); -void RevokeAndACK_free(struct LDKRevokeAndACK this_ptr); +/** + * Frees any resources used by the RevokeAndACK, if is_owned is set and inner is non-NULL. + */ +void RevokeAndACK_free(struct LDKRevokeAndACK this_obj); /** * The channel ID @@ -7071,11 +12247,20 @@ struct LDKPublicKey RevokeAndACK_get_next_per_commitment_point(const struct LDKR */ void RevokeAndACK_set_next_per_commitment_point(struct LDKRevokeAndACK *NONNULL_PTR this_ptr, struct LDKPublicKey val); +/** + * Constructs a new RevokeAndACK given each field + */ 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); +/** + * Creates a copy of the RevokeAndACK + */ struct LDKRevokeAndACK RevokeAndACK_clone(const struct LDKRevokeAndACK *NONNULL_PTR orig); -void UpdateFee_free(struct LDKUpdateFee this_ptr); +/** + * Frees any resources used by the UpdateFee, if is_owned is set and inner is non-NULL. + */ +void UpdateFee_free(struct LDKUpdateFee this_obj); /** * The channel ID @@ -7097,11 +12282,20 @@ uint32_t UpdateFee_get_feerate_per_kw(const struct LDKUpdateFee *NONNULL_PTR thi */ void UpdateFee_set_feerate_per_kw(struct LDKUpdateFee *NONNULL_PTR this_ptr, uint32_t val); +/** + * Constructs a new UpdateFee given each field + */ MUST_USE_RES struct LDKUpdateFee UpdateFee_new(struct LDKThirtyTwoBytes channel_id_arg, uint32_t feerate_per_kw_arg); +/** + * Creates a copy of the UpdateFee + */ struct LDKUpdateFee UpdateFee_clone(const struct LDKUpdateFee *NONNULL_PTR orig); -void DataLossProtect_free(struct LDKDataLossProtect this_ptr); +/** + * Frees any resources used by the DataLossProtect, if is_owned is set and inner is non-NULL. + */ +void DataLossProtect_free(struct LDKDataLossProtect this_obj); /** * Proof that the sender knows the per-commitment secret of a specific commitment transaction @@ -7125,11 +12319,20 @@ struct LDKPublicKey DataLossProtect_get_my_current_per_commitment_point(const st */ void DataLossProtect_set_my_current_per_commitment_point(struct LDKDataLossProtect *NONNULL_PTR this_ptr, struct LDKPublicKey val); +/** + * Constructs a new DataLossProtect given each field + */ MUST_USE_RES struct LDKDataLossProtect DataLossProtect_new(struct LDKThirtyTwoBytes your_last_per_commitment_secret_arg, struct LDKPublicKey my_current_per_commitment_point_arg); +/** + * Creates a copy of the DataLossProtect + */ struct LDKDataLossProtect DataLossProtect_clone(const struct LDKDataLossProtect *NONNULL_PTR orig); -void ChannelReestablish_free(struct LDKChannelReestablish this_ptr); +/** + * Frees any resources used by the ChannelReestablish, if is_owned is set and inner is non-NULL. + */ +void ChannelReestablish_free(struct LDKChannelReestablish this_obj); /** * The channel ID @@ -7161,9 +12364,15 @@ uint64_t ChannelReestablish_get_next_remote_commitment_number(const struct LDKCh */ void ChannelReestablish_set_next_remote_commitment_number(struct LDKChannelReestablish *NONNULL_PTR this_ptr, uint64_t val); +/** + * Creates a copy of the ChannelReestablish + */ struct LDKChannelReestablish ChannelReestablish_clone(const struct LDKChannelReestablish *NONNULL_PTR orig); -void AnnouncementSignatures_free(struct LDKAnnouncementSignatures this_ptr); +/** + * Frees any resources used by the AnnouncementSignatures, if is_owned is set and inner is non-NULL. + */ +void AnnouncementSignatures_free(struct LDKAnnouncementSignatures this_obj); /** * The channel ID @@ -7205,19 +12414,40 @@ struct LDKSignature AnnouncementSignatures_get_bitcoin_signature(const struct LD */ void AnnouncementSignatures_set_bitcoin_signature(struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr, struct LDKSignature val); +/** + * Constructs a new AnnouncementSignatures given each field + */ 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); +/** + * Creates a copy of the AnnouncementSignatures + */ struct LDKAnnouncementSignatures AnnouncementSignatures_clone(const struct LDKAnnouncementSignatures *NONNULL_PTR orig); +/** + * Frees any resources used by the NetAddress + */ void NetAddress_free(struct LDKNetAddress this_ptr); +/** + * Creates a copy of the NetAddress + */ struct LDKNetAddress NetAddress_clone(const struct LDKNetAddress *NONNULL_PTR orig); +/** + * Serialize the NetAddress object into a byte array which can be read by NetAddress_read + */ struct LDKCVec_u8Z NetAddress_write(const struct LDKNetAddress *NONNULL_PTR obj); +/** + * Read a Result from a byte array, created by Result_write + */ struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ Result_read(struct LDKu8slice ser); -void UnsignedNodeAnnouncement_free(struct LDKUnsignedNodeAnnouncement this_ptr); +/** + * Frees any resources used by the UnsignedNodeAnnouncement, if is_owned is set and inner is non-NULL. + */ +void UnsignedNodeAnnouncement_free(struct LDKUnsignedNodeAnnouncement this_obj); /** * The advertised features @@ -7278,9 +12508,15 @@ void UnsignedNodeAnnouncement_set_alias(struct LDKUnsignedNodeAnnouncement *NONN */ void UnsignedNodeAnnouncement_set_addresses(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKCVec_NetAddressZ val); +/** + * Creates a copy of the UnsignedNodeAnnouncement + */ struct LDKUnsignedNodeAnnouncement UnsignedNodeAnnouncement_clone(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR orig); -void NodeAnnouncement_free(struct LDKNodeAnnouncement this_ptr); +/** + * Frees any resources used by the NodeAnnouncement, if is_owned is set and inner is non-NULL. + */ +void NodeAnnouncement_free(struct LDKNodeAnnouncement this_obj); /** * The signature by the node key @@ -7302,11 +12538,20 @@ struct LDKUnsignedNodeAnnouncement NodeAnnouncement_get_contents(const struct LD */ void NodeAnnouncement_set_contents(struct LDKNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKUnsignedNodeAnnouncement val); +/** + * Constructs a new NodeAnnouncement given each field + */ MUST_USE_RES struct LDKNodeAnnouncement NodeAnnouncement_new(struct LDKSignature signature_arg, struct LDKUnsignedNodeAnnouncement contents_arg); +/** + * Creates a copy of the NodeAnnouncement + */ struct LDKNodeAnnouncement NodeAnnouncement_clone(const struct LDKNodeAnnouncement *NONNULL_PTR orig); -void UnsignedChannelAnnouncement_free(struct LDKUnsignedChannelAnnouncement this_ptr); +/** + * Frees any resources used by the UnsignedChannelAnnouncement, if is_owned is set and inner is non-NULL. + */ +void UnsignedChannelAnnouncement_free(struct LDKUnsignedChannelAnnouncement this_obj); /** * The advertised channel features @@ -7378,9 +12623,15 @@ struct LDKPublicKey UnsignedChannelAnnouncement_get_bitcoin_key_2(const struct L */ void UnsignedChannelAnnouncement_set_bitcoin_key_2(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKPublicKey val); +/** + * Creates a copy of the UnsignedChannelAnnouncement + */ struct LDKUnsignedChannelAnnouncement UnsignedChannelAnnouncement_clone(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR orig); -void ChannelAnnouncement_free(struct LDKChannelAnnouncement this_ptr); +/** + * Frees any resources used by the ChannelAnnouncement, if is_owned is set and inner is non-NULL. + */ +void ChannelAnnouncement_free(struct LDKChannelAnnouncement this_obj); /** * Authentication of the announcement by the first public node @@ -7432,11 +12683,20 @@ struct LDKUnsignedChannelAnnouncement ChannelAnnouncement_get_contents(const str */ void ChannelAnnouncement_set_contents(struct LDKChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKUnsignedChannelAnnouncement val); +/** + * Constructs a new ChannelAnnouncement given each field + */ 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); +/** + * Creates a copy of the ChannelAnnouncement + */ struct LDKChannelAnnouncement ChannelAnnouncement_clone(const struct LDKChannelAnnouncement *NONNULL_PTR orig); -void UnsignedChannelUpdate_free(struct LDKUnsignedChannelUpdate this_ptr); +/** + * Frees any resources used by the UnsignedChannelUpdate, if is_owned is set and inner is non-NULL. + */ +void UnsignedChannelUpdate_free(struct LDKUnsignedChannelUpdate this_obj); /** * The genesis hash of the blockchain where the channel is to be opened @@ -7479,12 +12739,26 @@ uint8_t UnsignedChannelUpdate_get_flags(const struct LDKUnsignedChannelUpdate *N void UnsignedChannelUpdate_set_flags(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint8_t val); /** - * The number of blocks to subtract from incoming HTLC cltv_expiry values + * The number of blocks such that if: + * `incoming_htlc.cltv_expiry < outgoing_htlc.cltv_expiry + cltv_expiry_delta` + * then we need to fail the HTLC backwards. When forwarding an HTLC, cltv_expiry_delta determines + * the outgoing HTLC's minimum cltv_expiry value -- so, if an incoming HTLC comes in with a + * cltv_expiry of 100000, and the node we're forwarding to has a cltv_expiry_delta value of 10, + * then we'll check that the outgoing HTLC's cltv_expiry value is at least 100010 before + * forwarding. Note that the HTLC sender is the one who originally sets this value when + * constructing the route. */ uint16_t UnsignedChannelUpdate_get_cltv_expiry_delta(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr); /** - * The number of blocks to subtract from incoming HTLC cltv_expiry values + * The number of blocks such that if: + * `incoming_htlc.cltv_expiry < outgoing_htlc.cltv_expiry + cltv_expiry_delta` + * then we need to fail the HTLC backwards. When forwarding an HTLC, cltv_expiry_delta determines + * the outgoing HTLC's minimum cltv_expiry value -- so, if an incoming HTLC comes in with a + * cltv_expiry of 100000, and the node we're forwarding to has a cltv_expiry_delta value of 10, + * then we'll check that the outgoing HTLC's cltv_expiry value is at least 100010 before + * forwarding. Note that the HTLC sender is the one who originally sets this value when + * constructing the route. */ void UnsignedChannelUpdate_set_cltv_expiry_delta(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint16_t val); @@ -7518,9 +12792,15 @@ uint32_t UnsignedChannelUpdate_get_fee_proportional_millionths(const struct LDKU */ void UnsignedChannelUpdate_set_fee_proportional_millionths(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint32_t val); +/** + * Creates a copy of the UnsignedChannelUpdate + */ struct LDKUnsignedChannelUpdate UnsignedChannelUpdate_clone(const struct LDKUnsignedChannelUpdate *NONNULL_PTR orig); -void ChannelUpdate_free(struct LDKChannelUpdate this_ptr); +/** + * Frees any resources used by the ChannelUpdate, if is_owned is set and inner is non-NULL. + */ +void ChannelUpdate_free(struct LDKChannelUpdate this_obj); /** * A signature of the channel update @@ -7542,11 +12822,20 @@ struct LDKUnsignedChannelUpdate ChannelUpdate_get_contents(const struct LDKChann */ void ChannelUpdate_set_contents(struct LDKChannelUpdate *NONNULL_PTR this_ptr, struct LDKUnsignedChannelUpdate val); +/** + * Constructs a new ChannelUpdate given each field + */ MUST_USE_RES struct LDKChannelUpdate ChannelUpdate_new(struct LDKSignature signature_arg, struct LDKUnsignedChannelUpdate contents_arg); +/** + * Creates a copy of the ChannelUpdate + */ struct LDKChannelUpdate ChannelUpdate_clone(const struct LDKChannelUpdate *NONNULL_PTR orig); -void QueryChannelRange_free(struct LDKQueryChannelRange this_ptr); +/** + * Frees any resources used by the QueryChannelRange, if is_owned is set and inner is non-NULL. + */ +void QueryChannelRange_free(struct LDKQueryChannelRange this_obj); /** * The genesis hash of the blockchain being queried @@ -7578,11 +12867,20 @@ uint32_t QueryChannelRange_get_number_of_blocks(const struct LDKQueryChannelRang */ void QueryChannelRange_set_number_of_blocks(struct LDKQueryChannelRange *NONNULL_PTR this_ptr, uint32_t val); +/** + * Constructs a new QueryChannelRange given each field + */ MUST_USE_RES struct LDKQueryChannelRange QueryChannelRange_new(struct LDKThirtyTwoBytes chain_hash_arg, uint32_t first_blocknum_arg, uint32_t number_of_blocks_arg); +/** + * Creates a copy of the QueryChannelRange + */ struct LDKQueryChannelRange QueryChannelRange_clone(const struct LDKQueryChannelRange *NONNULL_PTR orig); -void ReplyChannelRange_free(struct LDKReplyChannelRange this_ptr); +/** + * Frees any resources used by the ReplyChannelRange, if is_owned is set and inner is non-NULL. + */ +void ReplyChannelRange_free(struct LDKReplyChannelRange this_obj); /** * The genesis hash of the blockchain being queried @@ -7629,11 +12927,20 @@ void ReplyChannelRange_set_sync_complete(struct LDKReplyChannelRange *NONNULL_PT */ void ReplyChannelRange_set_short_channel_ids(struct LDKReplyChannelRange *NONNULL_PTR this_ptr, struct LDKCVec_u64Z val); +/** + * Constructs a new ReplyChannelRange given each field + */ 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); +/** + * Creates a copy of the ReplyChannelRange + */ struct LDKReplyChannelRange ReplyChannelRange_clone(const struct LDKReplyChannelRange *NONNULL_PTR orig); -void QueryShortChannelIds_free(struct LDKQueryShortChannelIds this_ptr); +/** + * Frees any resources used by the QueryShortChannelIds, if is_owned is set and inner is non-NULL. + */ +void QueryShortChannelIds_free(struct LDKQueryShortChannelIds this_obj); /** * The genesis hash of the blockchain being queried @@ -7650,11 +12957,20 @@ void QueryShortChannelIds_set_chain_hash(struct LDKQueryShortChannelIds *NONNULL */ void QueryShortChannelIds_set_short_channel_ids(struct LDKQueryShortChannelIds *NONNULL_PTR this_ptr, struct LDKCVec_u64Z val); +/** + * Constructs a new QueryShortChannelIds given each field + */ MUST_USE_RES struct LDKQueryShortChannelIds QueryShortChannelIds_new(struct LDKThirtyTwoBytes chain_hash_arg, struct LDKCVec_u64Z short_channel_ids_arg); +/** + * Creates a copy of the QueryShortChannelIds + */ struct LDKQueryShortChannelIds QueryShortChannelIds_clone(const struct LDKQueryShortChannelIds *NONNULL_PTR orig); -void ReplyShortChannelIdsEnd_free(struct LDKReplyShortChannelIdsEnd this_ptr); +/** + * Frees any resources used by the ReplyShortChannelIdsEnd, if is_owned is set and inner is non-NULL. + */ +void ReplyShortChannelIdsEnd_free(struct LDKReplyShortChannelIdsEnd this_obj); /** * The genesis hash of the blockchain that was queried @@ -7678,11 +12994,20 @@ bool ReplyShortChannelIdsEnd_get_full_information(const struct LDKReplyShortChan */ void ReplyShortChannelIdsEnd_set_full_information(struct LDKReplyShortChannelIdsEnd *NONNULL_PTR this_ptr, bool val); +/** + * Constructs a new ReplyShortChannelIdsEnd given each field + */ MUST_USE_RES struct LDKReplyShortChannelIdsEnd ReplyShortChannelIdsEnd_new(struct LDKThirtyTwoBytes chain_hash_arg, bool full_information_arg); +/** + * Creates a copy of the ReplyShortChannelIdsEnd + */ struct LDKReplyShortChannelIdsEnd ReplyShortChannelIdsEnd_clone(const struct LDKReplyShortChannelIdsEnd *NONNULL_PTR orig); -void GossipTimestampFilter_free(struct LDKGossipTimestampFilter this_ptr); +/** + * Frees any resources used by the GossipTimestampFilter, if is_owned is set and inner is non-NULL. + */ +void GossipTimestampFilter_free(struct LDKGossipTimestampFilter this_obj); /** * The genesis hash of the blockchain for channel and node information @@ -7714,15 +13039,30 @@ uint32_t GossipTimestampFilter_get_timestamp_range(const struct LDKGossipTimesta */ void GossipTimestampFilter_set_timestamp_range(struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr, uint32_t val); +/** + * Constructs a new GossipTimestampFilter given each field + */ MUST_USE_RES struct LDKGossipTimestampFilter GossipTimestampFilter_new(struct LDKThirtyTwoBytes chain_hash_arg, uint32_t first_timestamp_arg, uint32_t timestamp_range_arg); +/** + * Creates a copy of the GossipTimestampFilter + */ struct LDKGossipTimestampFilter GossipTimestampFilter_clone(const struct LDKGossipTimestampFilter *NONNULL_PTR orig); +/** + * Frees any resources used by the ErrorAction + */ void ErrorAction_free(struct LDKErrorAction this_ptr); +/** + * Creates a copy of the ErrorAction + */ struct LDKErrorAction ErrorAction_clone(const struct LDKErrorAction *NONNULL_PTR orig); -void LightningError_free(struct LDKLightningError this_ptr); +/** + * Frees any resources used by the LightningError, if is_owned is set and inner is non-NULL. + */ +void LightningError_free(struct LDKLightningError this_obj); /** * A human-readable message describing the error @@ -7744,11 +13084,20 @@ struct LDKErrorAction LightningError_get_action(const struct LDKLightningError * */ void LightningError_set_action(struct LDKLightningError *NONNULL_PTR this_ptr, struct LDKErrorAction val); +/** + * Constructs a new LightningError given each field + */ MUST_USE_RES struct LDKLightningError LightningError_new(struct LDKCVec_u8Z err_arg, struct LDKErrorAction action_arg); +/** + * Creates a copy of the LightningError + */ struct LDKLightningError LightningError_clone(const struct LDKLightningError *NONNULL_PTR orig); -void CommitmentUpdate_free(struct LDKCommitmentUpdate this_ptr); +/** + * Frees any resources used by the CommitmentUpdate, if is_owned is set and inner is non-NULL. + */ +void CommitmentUpdate_free(struct LDKCommitmentUpdate this_obj); /** * update_add_htlc messages which should be sent @@ -7790,12 +13139,24 @@ struct LDKCommitmentSigned CommitmentUpdate_get_commitment_signed(const struct L */ void CommitmentUpdate_set_commitment_signed(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKCommitmentSigned val); +/** + * Constructs a new CommitmentUpdate given each field + */ 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); +/** + * Creates a copy of the CommitmentUpdate + */ struct LDKCommitmentUpdate CommitmentUpdate_clone(const struct LDKCommitmentUpdate *NONNULL_PTR orig); +/** + * Frees any resources used by the HTLCFailChannelUpdate + */ void HTLCFailChannelUpdate_free(struct LDKHTLCFailChannelUpdate this_ptr); +/** + * Creates a copy of the HTLCFailChannelUpdate + */ struct LDKHTLCFailChannelUpdate HTLCFailChannelUpdate_clone(const struct LDKHTLCFailChannelUpdate *NONNULL_PTR orig); /** @@ -7808,150 +13169,369 @@ void ChannelMessageHandler_free(struct LDKChannelMessageHandler this_ptr); */ void RoutingMessageHandler_free(struct LDKRoutingMessageHandler this_ptr); +/** + * Serialize the AcceptChannel object into a byte array which can be read by AcceptChannel_read + */ struct LDKCVec_u8Z AcceptChannel_write(const struct LDKAcceptChannel *NONNULL_PTR obj); +/** + * Read a AcceptChannel from a byte array, created by AcceptChannel_write + */ struct LDKCResult_AcceptChannelDecodeErrorZ AcceptChannel_read(struct LDKu8slice ser); +/** + * Serialize the AnnouncementSignatures object into a byte array which can be read by AnnouncementSignatures_read + */ struct LDKCVec_u8Z AnnouncementSignatures_write(const struct LDKAnnouncementSignatures *NONNULL_PTR obj); +/** + * Read a AnnouncementSignatures from a byte array, created by AnnouncementSignatures_write + */ struct LDKCResult_AnnouncementSignaturesDecodeErrorZ AnnouncementSignatures_read(struct LDKu8slice ser); +/** + * Serialize the ChannelReestablish object into a byte array which can be read by ChannelReestablish_read + */ struct LDKCVec_u8Z ChannelReestablish_write(const struct LDKChannelReestablish *NONNULL_PTR obj); +/** + * Read a ChannelReestablish from a byte array, created by ChannelReestablish_write + */ struct LDKCResult_ChannelReestablishDecodeErrorZ ChannelReestablish_read(struct LDKu8slice ser); +/** + * Serialize the ClosingSigned object into a byte array which can be read by ClosingSigned_read + */ struct LDKCVec_u8Z ClosingSigned_write(const struct LDKClosingSigned *NONNULL_PTR obj); +/** + * Read a ClosingSigned from a byte array, created by ClosingSigned_write + */ struct LDKCResult_ClosingSignedDecodeErrorZ ClosingSigned_read(struct LDKu8slice ser); +/** + * Serialize the CommitmentSigned object into a byte array which can be read by CommitmentSigned_read + */ struct LDKCVec_u8Z CommitmentSigned_write(const struct LDKCommitmentSigned *NONNULL_PTR obj); +/** + * Read a CommitmentSigned from a byte array, created by CommitmentSigned_write + */ struct LDKCResult_CommitmentSignedDecodeErrorZ CommitmentSigned_read(struct LDKu8slice ser); +/** + * Serialize the FundingCreated object into a byte array which can be read by FundingCreated_read + */ struct LDKCVec_u8Z FundingCreated_write(const struct LDKFundingCreated *NONNULL_PTR obj); +/** + * Read a FundingCreated from a byte array, created by FundingCreated_write + */ struct LDKCResult_FundingCreatedDecodeErrorZ FundingCreated_read(struct LDKu8slice ser); +/** + * Serialize the FundingSigned object into a byte array which can be read by FundingSigned_read + */ struct LDKCVec_u8Z FundingSigned_write(const struct LDKFundingSigned *NONNULL_PTR obj); +/** + * Read a FundingSigned from a byte array, created by FundingSigned_write + */ struct LDKCResult_FundingSignedDecodeErrorZ FundingSigned_read(struct LDKu8slice ser); +/** + * Serialize the FundingLocked object into a byte array which can be read by FundingLocked_read + */ struct LDKCVec_u8Z FundingLocked_write(const struct LDKFundingLocked *NONNULL_PTR obj); +/** + * Read a FundingLocked from a byte array, created by FundingLocked_write + */ struct LDKCResult_FundingLockedDecodeErrorZ FundingLocked_read(struct LDKu8slice ser); +/** + * Serialize the Init object into a byte array which can be read by Init_read + */ struct LDKCVec_u8Z Init_write(const struct LDKInit *NONNULL_PTR obj); +/** + * Read a Init from a byte array, created by Init_write + */ struct LDKCResult_InitDecodeErrorZ Init_read(struct LDKu8slice ser); +/** + * Serialize the OpenChannel object into a byte array which can be read by OpenChannel_read + */ struct LDKCVec_u8Z OpenChannel_write(const struct LDKOpenChannel *NONNULL_PTR obj); +/** + * Read a OpenChannel from a byte array, created by OpenChannel_write + */ struct LDKCResult_OpenChannelDecodeErrorZ OpenChannel_read(struct LDKu8slice ser); +/** + * Serialize the RevokeAndACK object into a byte array which can be read by RevokeAndACK_read + */ struct LDKCVec_u8Z RevokeAndACK_write(const struct LDKRevokeAndACK *NONNULL_PTR obj); +/** + * Read a RevokeAndACK from a byte array, created by RevokeAndACK_write + */ struct LDKCResult_RevokeAndACKDecodeErrorZ RevokeAndACK_read(struct LDKu8slice ser); +/** + * Serialize the Shutdown object into a byte array which can be read by Shutdown_read + */ struct LDKCVec_u8Z Shutdown_write(const struct LDKShutdown *NONNULL_PTR obj); +/** + * Read a Shutdown from a byte array, created by Shutdown_write + */ struct LDKCResult_ShutdownDecodeErrorZ Shutdown_read(struct LDKu8slice ser); +/** + * Serialize the UpdateFailHTLC object into a byte array which can be read by UpdateFailHTLC_read + */ struct LDKCVec_u8Z UpdateFailHTLC_write(const struct LDKUpdateFailHTLC *NONNULL_PTR obj); +/** + * Read a UpdateFailHTLC from a byte array, created by UpdateFailHTLC_write + */ struct LDKCResult_UpdateFailHTLCDecodeErrorZ UpdateFailHTLC_read(struct LDKu8slice ser); +/** + * Serialize the UpdateFailMalformedHTLC object into a byte array which can be read by UpdateFailMalformedHTLC_read + */ struct LDKCVec_u8Z UpdateFailMalformedHTLC_write(const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR obj); +/** + * Read a UpdateFailMalformedHTLC from a byte array, created by UpdateFailMalformedHTLC_write + */ struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ UpdateFailMalformedHTLC_read(struct LDKu8slice ser); +/** + * Serialize the UpdateFee object into a byte array which can be read by UpdateFee_read + */ struct LDKCVec_u8Z UpdateFee_write(const struct LDKUpdateFee *NONNULL_PTR obj); +/** + * Read a UpdateFee from a byte array, created by UpdateFee_write + */ struct LDKCResult_UpdateFeeDecodeErrorZ UpdateFee_read(struct LDKu8slice ser); +/** + * Serialize the UpdateFulfillHTLC object into a byte array which can be read by UpdateFulfillHTLC_read + */ struct LDKCVec_u8Z UpdateFulfillHTLC_write(const struct LDKUpdateFulfillHTLC *NONNULL_PTR obj); +/** + * Read a UpdateFulfillHTLC from a byte array, created by UpdateFulfillHTLC_write + */ struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ UpdateFulfillHTLC_read(struct LDKu8slice ser); +/** + * Serialize the UpdateAddHTLC object into a byte array which can be read by UpdateAddHTLC_read + */ struct LDKCVec_u8Z UpdateAddHTLC_write(const struct LDKUpdateAddHTLC *NONNULL_PTR obj); +/** + * Read a UpdateAddHTLC from a byte array, created by UpdateAddHTLC_write + */ struct LDKCResult_UpdateAddHTLCDecodeErrorZ UpdateAddHTLC_read(struct LDKu8slice ser); +/** + * Serialize the Ping object into a byte array which can be read by Ping_read + */ struct LDKCVec_u8Z Ping_write(const struct LDKPing *NONNULL_PTR obj); +/** + * Read a Ping from a byte array, created by Ping_write + */ struct LDKCResult_PingDecodeErrorZ Ping_read(struct LDKu8slice ser); +/** + * Serialize the Pong object into a byte array which can be read by Pong_read + */ struct LDKCVec_u8Z Pong_write(const struct LDKPong *NONNULL_PTR obj); +/** + * Read a Pong from a byte array, created by Pong_write + */ struct LDKCResult_PongDecodeErrorZ Pong_read(struct LDKu8slice ser); +/** + * Serialize the UnsignedChannelAnnouncement object into a byte array which can be read by UnsignedChannelAnnouncement_read + */ struct LDKCVec_u8Z UnsignedChannelAnnouncement_write(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR obj); +/** + * Read a UnsignedChannelAnnouncement from a byte array, created by UnsignedChannelAnnouncement_write + */ struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ UnsignedChannelAnnouncement_read(struct LDKu8slice ser); +/** + * Serialize the ChannelAnnouncement object into a byte array which can be read by ChannelAnnouncement_read + */ struct LDKCVec_u8Z ChannelAnnouncement_write(const struct LDKChannelAnnouncement *NONNULL_PTR obj); +/** + * Read a ChannelAnnouncement from a byte array, created by ChannelAnnouncement_write + */ struct LDKCResult_ChannelAnnouncementDecodeErrorZ ChannelAnnouncement_read(struct LDKu8slice ser); +/** + * Serialize the UnsignedChannelUpdate object into a byte array which can be read by UnsignedChannelUpdate_read + */ struct LDKCVec_u8Z UnsignedChannelUpdate_write(const struct LDKUnsignedChannelUpdate *NONNULL_PTR obj); +/** + * Read a UnsignedChannelUpdate from a byte array, created by UnsignedChannelUpdate_write + */ struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ UnsignedChannelUpdate_read(struct LDKu8slice ser); +/** + * Serialize the ChannelUpdate object into a byte array which can be read by ChannelUpdate_read + */ struct LDKCVec_u8Z ChannelUpdate_write(const struct LDKChannelUpdate *NONNULL_PTR obj); +/** + * Read a ChannelUpdate from a byte array, created by ChannelUpdate_write + */ struct LDKCResult_ChannelUpdateDecodeErrorZ ChannelUpdate_read(struct LDKu8slice ser); +/** + * Serialize the ErrorMessage object into a byte array which can be read by ErrorMessage_read + */ struct LDKCVec_u8Z ErrorMessage_write(const struct LDKErrorMessage *NONNULL_PTR obj); +/** + * Read a ErrorMessage from a byte array, created by ErrorMessage_write + */ struct LDKCResult_ErrorMessageDecodeErrorZ ErrorMessage_read(struct LDKu8slice ser); +/** + * Serialize the UnsignedNodeAnnouncement object into a byte array which can be read by UnsignedNodeAnnouncement_read + */ struct LDKCVec_u8Z UnsignedNodeAnnouncement_write(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR obj); +/** + * Read a UnsignedNodeAnnouncement from a byte array, created by UnsignedNodeAnnouncement_write + */ struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ UnsignedNodeAnnouncement_read(struct LDKu8slice ser); +/** + * Serialize the NodeAnnouncement object into a byte array which can be read by NodeAnnouncement_read + */ struct LDKCVec_u8Z NodeAnnouncement_write(const struct LDKNodeAnnouncement *NONNULL_PTR obj); +/** + * Read a NodeAnnouncement from a byte array, created by NodeAnnouncement_write + */ struct LDKCResult_NodeAnnouncementDecodeErrorZ NodeAnnouncement_read(struct LDKu8slice ser); +/** + * Read a QueryShortChannelIds from a byte array, created by QueryShortChannelIds_write + */ struct LDKCResult_QueryShortChannelIdsDecodeErrorZ QueryShortChannelIds_read(struct LDKu8slice ser); +/** + * Serialize the QueryShortChannelIds object into a byte array which can be read by QueryShortChannelIds_read + */ struct LDKCVec_u8Z QueryShortChannelIds_write(const struct LDKQueryShortChannelIds *NONNULL_PTR obj); +/** + * Read a ReplyShortChannelIdsEnd from a byte array, created by ReplyShortChannelIdsEnd_write + */ struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ ReplyShortChannelIdsEnd_read(struct LDKu8slice ser); +/** + * Serialize the ReplyShortChannelIdsEnd object into a byte array which can be read by ReplyShortChannelIdsEnd_read + */ struct LDKCVec_u8Z ReplyShortChannelIdsEnd_write(const struct LDKReplyShortChannelIdsEnd *NONNULL_PTR obj); +/** + *\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 + */ +MUST_USE_RES uint32_t QueryChannelRange_end_blocknum(const struct LDKQueryChannelRange *NONNULL_PTR this_arg); + +/** + * Read a QueryChannelRange from a byte array, created by QueryChannelRange_write + */ struct LDKCResult_QueryChannelRangeDecodeErrorZ QueryChannelRange_read(struct LDKu8slice ser); +/** + * Serialize the QueryChannelRange object into a byte array which can be read by QueryChannelRange_read + */ struct LDKCVec_u8Z QueryChannelRange_write(const struct LDKQueryChannelRange *NONNULL_PTR obj); +/** + * Read a ReplyChannelRange from a byte array, created by ReplyChannelRange_write + */ struct LDKCResult_ReplyChannelRangeDecodeErrorZ ReplyChannelRange_read(struct LDKu8slice ser); +/** + * Serialize the ReplyChannelRange object into a byte array which can be read by ReplyChannelRange_read + */ struct LDKCVec_u8Z ReplyChannelRange_write(const struct LDKReplyChannelRange *NONNULL_PTR obj); +/** + * Read a GossipTimestampFilter from a byte array, created by GossipTimestampFilter_write + */ struct LDKCResult_GossipTimestampFilterDecodeErrorZ GossipTimestampFilter_read(struct LDKu8slice ser); +/** + * Serialize the GossipTimestampFilter object into a byte array which can be read by GossipTimestampFilter_read + */ struct LDKCVec_u8Z GossipTimestampFilter_write(const struct LDKGossipTimestampFilter *NONNULL_PTR obj); -void IgnoringMessageHandler_free(struct LDKIgnoringMessageHandler this_ptr); +/** + * Frees any resources used by the IgnoringMessageHandler, if is_owned is set and inner is non-NULL. + */ +void IgnoringMessageHandler_free(struct LDKIgnoringMessageHandler this_obj); +/** + * Constructs a new IgnoringMessageHandler given each field + */ MUST_USE_RES struct LDKIgnoringMessageHandler IgnoringMessageHandler_new(void); +/** + * Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg. + * This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is + */ struct LDKMessageSendEventsProvider IgnoringMessageHandler_as_MessageSendEventsProvider(const struct LDKIgnoringMessageHandler *NONNULL_PTR this_arg); +/** + * Constructs a new RoutingMessageHandler which calls the relevant methods on this_arg. + * This copies the `inner` pointer in this_arg and thus the returned RoutingMessageHandler must be freed before this_arg is + */ struct LDKRoutingMessageHandler IgnoringMessageHandler_as_RoutingMessageHandler(const struct LDKIgnoringMessageHandler *NONNULL_PTR this_arg); -void ErroringMessageHandler_free(struct LDKErroringMessageHandler this_ptr); +/** + * Frees any resources used by the ErroringMessageHandler, if is_owned is set and inner is non-NULL. + */ +void ErroringMessageHandler_free(struct LDKErroringMessageHandler this_obj); /** * Constructs a new ErroringMessageHandler */ MUST_USE_RES struct LDKErroringMessageHandler ErroringMessageHandler_new(void); +/** + * Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg. + * This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is + */ struct LDKMessageSendEventsProvider ErroringMessageHandler_as_MessageSendEventsProvider(const struct LDKErroringMessageHandler *NONNULL_PTR this_arg); +/** + * Constructs a new ChannelMessageHandler which calls the relevant methods on this_arg. + * This copies the `inner` pointer in this_arg and thus the returned ChannelMessageHandler must be freed before this_arg is + */ struct LDKChannelMessageHandler ErroringMessageHandler_as_ChannelMessageHandler(const struct LDKErroringMessageHandler *NONNULL_PTR this_arg); -void MessageHandler_free(struct LDKMessageHandler this_ptr); +/** + * Frees any resources used by the MessageHandler, if is_owned is set and inner is non-NULL. + */ +void MessageHandler_free(struct LDKMessageHandler this_obj); /** * A message handler which handles messages specific to channels. Usually this is just a @@ -7977,8 +13557,14 @@ const struct LDKRoutingMessageHandler *MessageHandler_get_route_handler(const st */ void MessageHandler_set_route_handler(struct LDKMessageHandler *NONNULL_PTR this_ptr, struct LDKRoutingMessageHandler val); +/** + * Constructs a new MessageHandler given each field + */ MUST_USE_RES struct LDKMessageHandler MessageHandler_new(struct LDKChannelMessageHandler chan_handler_arg, struct LDKRoutingMessageHandler route_handler_arg); +/** + * Creates a copy of a SocketDescriptor + */ struct LDKSocketDescriptor SocketDescriptor_clone(const struct LDKSocketDescriptor *NONNULL_PTR orig); /** @@ -7986,7 +13572,10 @@ struct LDKSocketDescriptor SocketDescriptor_clone(const struct LDKSocketDescript */ void SocketDescriptor_free(struct LDKSocketDescriptor this_ptr); -void PeerHandleError_free(struct LDKPeerHandleError this_ptr); +/** + * Frees any resources used by the PeerHandleError, if is_owned is set and inner is non-NULL. + */ +void PeerHandleError_free(struct LDKPeerHandleError this_obj); /** * Used to indicate that we probably can't make any future connections to this peer, implying @@ -8000,11 +13589,20 @@ bool PeerHandleError_get_no_connection_possible(const struct LDKPeerHandleError */ void PeerHandleError_set_no_connection_possible(struct LDKPeerHandleError *NONNULL_PTR this_ptr, bool val); +/** + * Constructs a new PeerHandleError given each field + */ MUST_USE_RES struct LDKPeerHandleError PeerHandleError_new(bool no_connection_possible_arg); +/** + * Creates a copy of the PeerHandleError + */ struct LDKPeerHandleError PeerHandleError_clone(const struct LDKPeerHandleError *NONNULL_PTR orig); -void PeerManager_free(struct LDKPeerManager this_ptr); +/** + * Frees any resources used by the PeerManager, if is_owned is set and inner is non-NULL. + */ +void PeerManager_free(struct LDKPeerManager this_obj); /** * Constructs a new PeerManager with the given message handlers and node_id secret key @@ -8112,7 +13710,7 @@ void PeerManager_disconnect_by_node_id(const struct LDKPeerManager *NONNULL_PTR * It will send pings to each peer and disconnect those which did not respond to the last round of pings. * Will most likely call send_data on all of the registered descriptors, thus, be very careful with reentrancy issues! */ -void PeerManager_timer_tick_occured(const struct LDKPeerManager *NONNULL_PTR this_arg); +void PeerManager_timer_tick_occurred(const struct LDKPeerManager *NONNULL_PTR this_arg); /** * Build the commitment secret from the seed and the commitment number @@ -8166,7 +13764,10 @@ struct LDKCResult_SecretKeyErrorZ derive_private_revocation_key(const uint8_t (* */ struct LDKCResult_PublicKeyErrorZ derive_public_revocation_key(struct LDKPublicKey per_commitment_point, struct LDKPublicKey countersignatory_revocation_base_point); -void TxCreationKeys_free(struct LDKTxCreationKeys this_ptr); +/** + * Frees any resources used by the TxCreationKeys, if is_owned is set and inner is non-NULL. + */ +void TxCreationKeys_free(struct LDKTxCreationKeys this_obj); /** * The broadcaster's per-commitment public key which was used to derive the other keys. @@ -8222,15 +13823,30 @@ struct LDKPublicKey TxCreationKeys_get_broadcaster_delayed_payment_key(const str */ void TxCreationKeys_set_broadcaster_delayed_payment_key(struct LDKTxCreationKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val); +/** + * Constructs a new TxCreationKeys given each field + */ 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); +/** + * Creates a copy of the TxCreationKeys + */ struct LDKTxCreationKeys TxCreationKeys_clone(const struct LDKTxCreationKeys *NONNULL_PTR orig); +/** + * Serialize the TxCreationKeys object into a byte array which can be read by TxCreationKeys_read + */ struct LDKCVec_u8Z TxCreationKeys_write(const struct LDKTxCreationKeys *NONNULL_PTR obj); +/** + * Read a TxCreationKeys from a byte array, created by TxCreationKeys_write + */ struct LDKCResult_TxCreationKeysDecodeErrorZ TxCreationKeys_read(struct LDKu8slice ser); -void ChannelPublicKeys_free(struct LDKChannelPublicKeys this_ptr); +/** + * Frees any resources used by the ChannelPublicKeys, if is_owned is set and inner is non-NULL. + */ +void ChannelPublicKeys_free(struct LDKChannelPublicKeys this_obj); /** * The public key which is used to sign all commitment transactions, as it appears in the @@ -8300,12 +13916,24 @@ struct LDKPublicKey ChannelPublicKeys_get_htlc_basepoint(const struct LDKChannel */ void ChannelPublicKeys_set_htlc_basepoint(struct LDKChannelPublicKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val); +/** + * Constructs a new ChannelPublicKeys given each field + */ 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); +/** + * Creates a copy of the ChannelPublicKeys + */ struct LDKChannelPublicKeys ChannelPublicKeys_clone(const struct LDKChannelPublicKeys *NONNULL_PTR orig); +/** + * Serialize the ChannelPublicKeys object into a byte array which can be read by ChannelPublicKeys_read + */ struct LDKCVec_u8Z ChannelPublicKeys_write(const struct LDKChannelPublicKeys *NONNULL_PTR obj); +/** + * Read a ChannelPublicKeys from a byte array, created by ChannelPublicKeys_write + */ struct LDKCResult_ChannelPublicKeysDecodeErrorZ ChannelPublicKeys_read(struct LDKu8slice ser); /** @@ -8327,7 +13955,10 @@ MUST_USE_RES struct LDKCResult_TxCreationKeysErrorZ TxCreationKeys_from_channel_ */ struct LDKCVec_u8Z get_revokeable_redeemscript(struct LDKPublicKey revocation_key, uint16_t contest_delay, struct LDKPublicKey broadcaster_delayed_payment_key); -void HTLCOutputInCommitment_free(struct LDKHTLCOutputInCommitment this_ptr); +/** + * Frees any resources used by the HTLCOutputInCommitment, if is_owned is set and inner is non-NULL. + */ +void HTLCOutputInCommitment_free(struct LDKHTLCOutputInCommitment this_obj); /** * Whether the HTLC was \"offered\" (ie outbound in relation to this commitment transaction). @@ -8377,10 +14008,38 @@ const uint8_t (*HTLCOutputInCommitment_get_payment_hash(const struct LDKHTLCOutp */ void HTLCOutputInCommitment_set_payment_hash(struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val); +/** + * The position within the commitment transactions' outputs. This may be None if the value is + * below the dust limit (in which case no output appears in the commitment transaction and the + * value is spent to additional transaction fees). + */ +struct LDKCOption_u32Z HTLCOutputInCommitment_get_transaction_output_index(const struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr); + +/** + * The position within the commitment transactions' outputs. This may be None if the value is + * below the dust limit (in which case no output appears in the commitment transaction and the + * value is spent to additional transaction fees). + */ +void HTLCOutputInCommitment_set_transaction_output_index(struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr, struct LDKCOption_u32Z val); + +/** + * Constructs a new HTLCOutputInCommitment given each field + */ +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); + +/** + * Creates a copy of the HTLCOutputInCommitment + */ struct LDKHTLCOutputInCommitment HTLCOutputInCommitment_clone(const struct LDKHTLCOutputInCommitment *NONNULL_PTR orig); +/** + * Serialize the HTLCOutputInCommitment object into a byte array which can be read by HTLCOutputInCommitment_read + */ struct LDKCVec_u8Z HTLCOutputInCommitment_write(const struct LDKHTLCOutputInCommitment *NONNULL_PTR obj); +/** + * Read a HTLCOutputInCommitment from a byte array, created by HTLCOutputInCommitment_write + */ struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ HTLCOutputInCommitment_read(struct LDKu8slice ser); /** @@ -8400,7 +14059,10 @@ struct LDKCVec_u8Z make_funding_redeemscript(struct LDKPublicKey broadcaster, st */ 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); -void ChannelTransactionParameters_free(struct LDKChannelTransactionParameters this_ptr); +/** + * Frees any resources used by the ChannelTransactionParameters, if is_owned is set and inner is non-NULL. + */ +void ChannelTransactionParameters_free(struct LDKChannelTransactionParameters this_obj); /** * Holder public keys @@ -8456,11 +14118,20 @@ struct LDKOutPoint ChannelTransactionParameters_get_funding_outpoint(const struc */ void ChannelTransactionParameters_set_funding_outpoint(struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr, struct LDKOutPoint val); +/** + * Constructs a new ChannelTransactionParameters given each field + */ 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); +/** + * Creates a copy of the ChannelTransactionParameters + */ struct LDKChannelTransactionParameters ChannelTransactionParameters_clone(const struct LDKChannelTransactionParameters *NONNULL_PTR orig); -void CounterpartyChannelTransactionParameters_free(struct LDKCounterpartyChannelTransactionParameters this_ptr); +/** + * Frees any resources used by the CounterpartyChannelTransactionParameters, if is_owned is set and inner is non-NULL. + */ +void CounterpartyChannelTransactionParameters_free(struct LDKCounterpartyChannelTransactionParameters this_obj); /** * Counter-party public keys @@ -8482,8 +14153,14 @@ uint16_t CounterpartyChannelTransactionParameters_get_selected_contest_delay(con */ void CounterpartyChannelTransactionParameters_set_selected_contest_delay(struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR this_ptr, uint16_t val); +/** + * Constructs a new CounterpartyChannelTransactionParameters given each field + */ MUST_USE_RES struct LDKCounterpartyChannelTransactionParameters CounterpartyChannelTransactionParameters_new(struct LDKChannelPublicKeys pubkeys_arg, uint16_t selected_contest_delay_arg); +/** + * Creates a copy of the CounterpartyChannelTransactionParameters + */ struct LDKCounterpartyChannelTransactionParameters CounterpartyChannelTransactionParameters_clone(const struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR orig); /** @@ -8507,15 +14184,30 @@ MUST_USE_RES struct LDKDirectedChannelTransactionParameters ChannelTransactionPa */ MUST_USE_RES struct LDKDirectedChannelTransactionParameters ChannelTransactionParameters_as_counterparty_broadcastable(const struct LDKChannelTransactionParameters *NONNULL_PTR this_arg); +/** + * Serialize the CounterpartyChannelTransactionParameters object into a byte array which can be read by CounterpartyChannelTransactionParameters_read + */ struct LDKCVec_u8Z CounterpartyChannelTransactionParameters_write(const struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR obj); +/** + * Read a CounterpartyChannelTransactionParameters from a byte array, created by CounterpartyChannelTransactionParameters_write + */ struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ CounterpartyChannelTransactionParameters_read(struct LDKu8slice ser); +/** + * Serialize the ChannelTransactionParameters object into a byte array which can be read by ChannelTransactionParameters_read + */ struct LDKCVec_u8Z ChannelTransactionParameters_write(const struct LDKChannelTransactionParameters *NONNULL_PTR obj); +/** + * Read a ChannelTransactionParameters from a byte array, created by ChannelTransactionParameters_write + */ struct LDKCResult_ChannelTransactionParametersDecodeErrorZ ChannelTransactionParameters_read(struct LDKu8slice ser); -void DirectedChannelTransactionParameters_free(struct LDKDirectedChannelTransactionParameters this_ptr); +/** + * Frees any resources used by the DirectedChannelTransactionParameters, if is_owned is set and inner is non-NULL. + */ +void DirectedChannelTransactionParameters_free(struct LDKDirectedChannelTransactionParameters this_obj); /** * Get the channel pubkeys for the broadcaster @@ -8546,7 +14238,10 @@ MUST_USE_RES bool DirectedChannelTransactionParameters_is_outbound(const struct */ MUST_USE_RES struct LDKOutPoint DirectedChannelTransactionParameters_funding_outpoint(const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR this_arg); -void HolderCommitmentTransaction_free(struct LDKHolderCommitmentTransaction this_ptr); +/** + * Frees any resources used by the HolderCommitmentTransaction, if is_owned is set and inner is non-NULL. + */ +void HolderCommitmentTransaction_free(struct LDKHolderCommitmentTransaction this_obj); /** * Our counterparty's signature for the transaction @@ -8563,10 +14258,19 @@ void HolderCommitmentTransaction_set_counterparty_sig(struct LDKHolderCommitment */ void HolderCommitmentTransaction_set_counterparty_htlc_sigs(struct LDKHolderCommitmentTransaction *NONNULL_PTR this_ptr, struct LDKCVec_SignatureZ val); +/** + * Creates a copy of the HolderCommitmentTransaction + */ struct LDKHolderCommitmentTransaction HolderCommitmentTransaction_clone(const struct LDKHolderCommitmentTransaction *NONNULL_PTR orig); +/** + * Serialize the HolderCommitmentTransaction object into a byte array which can be read by HolderCommitmentTransaction_read + */ struct LDKCVec_u8Z HolderCommitmentTransaction_write(const struct LDKHolderCommitmentTransaction *NONNULL_PTR obj); +/** + * Read a HolderCommitmentTransaction from a byte array, created by HolderCommitmentTransaction_write + */ struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ HolderCommitmentTransaction_read(struct LDKu8slice ser); /** @@ -8575,7 +14279,10 @@ struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ HolderCommitmentTransa */ 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); -void BuiltCommitmentTransaction_free(struct LDKBuiltCommitmentTransaction this_ptr); +/** + * Frees any resources used by the BuiltCommitmentTransaction, if is_owned is set and inner is non-NULL. + */ +void BuiltCommitmentTransaction_free(struct LDKBuiltCommitmentTransaction this_obj); /** * The commitment transaction @@ -8603,12 +14310,24 @@ const uint8_t (*BuiltCommitmentTransaction_get_txid(const struct LDKBuiltCommitm */ void BuiltCommitmentTransaction_set_txid(struct LDKBuiltCommitmentTransaction *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val); +/** + * Constructs a new BuiltCommitmentTransaction given each field + */ MUST_USE_RES struct LDKBuiltCommitmentTransaction BuiltCommitmentTransaction_new(struct LDKTransaction transaction_arg, struct LDKThirtyTwoBytes txid_arg); +/** + * Creates a copy of the BuiltCommitmentTransaction + */ struct LDKBuiltCommitmentTransaction BuiltCommitmentTransaction_clone(const struct LDKBuiltCommitmentTransaction *NONNULL_PTR orig); +/** + * Serialize the BuiltCommitmentTransaction object into a byte array which can be read by BuiltCommitmentTransaction_read + */ struct LDKCVec_u8Z BuiltCommitmentTransaction_write(const struct LDKBuiltCommitmentTransaction *NONNULL_PTR obj); +/** + * Read a BuiltCommitmentTransaction from a byte array, created by BuiltCommitmentTransaction_write + */ struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ BuiltCommitmentTransaction_read(struct LDKu8slice ser); /** @@ -8624,12 +14343,24 @@ MUST_USE_RES struct LDKThirtyTwoBytes BuiltCommitmentTransaction_get_sighash_all */ 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); -void CommitmentTransaction_free(struct LDKCommitmentTransaction this_ptr); +/** + * Frees any resources used by the CommitmentTransaction, if is_owned is set and inner is non-NULL. + */ +void CommitmentTransaction_free(struct LDKCommitmentTransaction this_obj); +/** + * Creates a copy of the CommitmentTransaction + */ struct LDKCommitmentTransaction CommitmentTransaction_clone(const struct LDKCommitmentTransaction *NONNULL_PTR orig); +/** + * Serialize the CommitmentTransaction object into a byte array which can be read by CommitmentTransaction_read + */ struct LDKCVec_u8Z CommitmentTransaction_write(const struct LDKCommitmentTransaction *NONNULL_PTR obj); +/** + * Read a CommitmentTransaction from a byte array, created by CommitmentTransaction_write + */ struct LDKCResult_CommitmentTransactionDecodeErrorZ CommitmentTransaction_read(struct LDKu8slice ser); /** @@ -8672,7 +14403,10 @@ MUST_USE_RES struct LDKTrustedCommitmentTransaction CommitmentTransaction_trust( */ 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); -void TrustedCommitmentTransaction_free(struct LDKTrustedCommitmentTransaction this_ptr); +/** + * Frees any resources used by the TrustedCommitmentTransaction, if is_owned is set and inner is non-NULL. + */ +void TrustedCommitmentTransaction_free(struct LDKTrustedCommitmentTransaction this_obj); /** * The transaction ID of the built Bitcoin transaction @@ -8702,17 +14436,45 @@ MUST_USE_RES struct LDKCResult_CVec_SignatureZNoneZ TrustedCommitmentTransaction */ uint64_t get_commitment_transaction_number_obscure_factor(struct LDKPublicKey broadcaster_payment_basepoint, struct LDKPublicKey countersignatory_payment_basepoint, bool outbound_from_broadcaster); +/** + * Creates a copy of the InitFeatures + */ struct LDKInitFeatures InitFeatures_clone(const struct LDKInitFeatures *NONNULL_PTR orig); +/** + * Creates a copy of the NodeFeatures + */ struct LDKNodeFeatures NodeFeatures_clone(const struct LDKNodeFeatures *NONNULL_PTR orig); +/** + * Creates a copy of the ChannelFeatures + */ struct LDKChannelFeatures ChannelFeatures_clone(const struct LDKChannelFeatures *NONNULL_PTR orig); -void InitFeatures_free(struct LDKInitFeatures this_ptr); +/** + * Creates a copy of the InvoiceFeatures + */ +struct LDKInvoiceFeatures InvoiceFeatures_clone(const struct LDKInvoiceFeatures *NONNULL_PTR orig); + +/** + * Frees any resources used by the InitFeatures, if is_owned is set and inner is non-NULL. + */ +void InitFeatures_free(struct LDKInitFeatures this_obj); + +/** + * Frees any resources used by the NodeFeatures, if is_owned is set and inner is non-NULL. + */ +void NodeFeatures_free(struct LDKNodeFeatures this_obj); -void NodeFeatures_free(struct LDKNodeFeatures this_ptr); +/** + * Frees any resources used by the ChannelFeatures, if is_owned is set and inner is non-NULL. + */ +void ChannelFeatures_free(struct LDKChannelFeatures this_obj); -void ChannelFeatures_free(struct LDKChannelFeatures this_ptr); +/** + * Frees any resources used by the InvoiceFeatures, if is_owned is set and inner is non-NULL. + */ +void InvoiceFeatures_free(struct LDKInvoiceFeatures this_obj); /** * Create a blank Features with no features set @@ -8720,9 +14482,7 @@ void ChannelFeatures_free(struct LDKChannelFeatures this_ptr); MUST_USE_RES struct LDKInitFeatures InitFeatures_empty(void); /** - * Creates features known by the implementation as defined by [`T::KNOWN_FEATURE_FLAGS`]. - * - * [`T::KNOWN_FEATURE_FLAGS`]: sealed/trait.Context.html#associatedconstant.KNOWN_FEATURE_FLAGS + * Creates a Features with the bits set which are known by the implementation */ MUST_USE_RES struct LDKInitFeatures InitFeatures_known(void); @@ -8732,9 +14492,7 @@ MUST_USE_RES struct LDKInitFeatures InitFeatures_known(void); MUST_USE_RES struct LDKNodeFeatures NodeFeatures_empty(void); /** - * Creates features known by the implementation as defined by [`T::KNOWN_FEATURE_FLAGS`]. - * - * [`T::KNOWN_FEATURE_FLAGS`]: sealed/trait.Context.html#associatedconstant.KNOWN_FEATURE_FLAGS + * Creates a Features with the bits set which are known by the implementation */ MUST_USE_RES struct LDKNodeFeatures NodeFeatures_known(void); @@ -8744,25 +14502,64 @@ MUST_USE_RES struct LDKNodeFeatures NodeFeatures_known(void); MUST_USE_RES struct LDKChannelFeatures ChannelFeatures_empty(void); /** - * Creates features known by the implementation as defined by [`T::KNOWN_FEATURE_FLAGS`]. - * - * [`T::KNOWN_FEATURE_FLAGS`]: sealed/trait.Context.html#associatedconstant.KNOWN_FEATURE_FLAGS + * Creates a Features with the bits set which are known by the implementation */ MUST_USE_RES struct LDKChannelFeatures ChannelFeatures_known(void); +/** + * Create a blank Features with no features set + */ +MUST_USE_RES struct LDKInvoiceFeatures InvoiceFeatures_empty(void); + +/** + * Creates a Features with the bits set which are known by the implementation + */ +MUST_USE_RES struct LDKInvoiceFeatures InvoiceFeatures_known(void); + +/** + * Serialize the InitFeatures object into a byte array which can be read by InitFeatures_read + */ struct LDKCVec_u8Z InitFeatures_write(const struct LDKInitFeatures *NONNULL_PTR obj); +/** + * Serialize the NodeFeatures object into a byte array which can be read by NodeFeatures_read + */ struct LDKCVec_u8Z NodeFeatures_write(const struct LDKNodeFeatures *NONNULL_PTR obj); +/** + * Serialize the ChannelFeatures object into a byte array which can be read by ChannelFeatures_read + */ struct LDKCVec_u8Z ChannelFeatures_write(const struct LDKChannelFeatures *NONNULL_PTR obj); +/** + * Serialize the InvoiceFeatures object into a byte array which can be read by InvoiceFeatures_read + */ +struct LDKCVec_u8Z InvoiceFeatures_write(const struct LDKInvoiceFeatures *NONNULL_PTR obj); + +/** + * Read a InitFeatures from a byte array, created by InitFeatures_write + */ struct LDKCResult_InitFeaturesDecodeErrorZ InitFeatures_read(struct LDKu8slice ser); +/** + * Read a NodeFeatures from a byte array, created by NodeFeatures_write + */ struct LDKCResult_NodeFeaturesDecodeErrorZ NodeFeatures_read(struct LDKu8slice ser); +/** + * Read a ChannelFeatures from a byte array, created by ChannelFeatures_write + */ struct LDKCResult_ChannelFeaturesDecodeErrorZ ChannelFeatures_read(struct LDKu8slice ser); -void RouteHop_free(struct LDKRouteHop this_ptr); +/** + * Read a InvoiceFeatures from a byte array, created by InvoiceFeatures_write + */ +struct LDKCResult_InvoiceFeaturesDecodeErrorZ InvoiceFeatures_read(struct LDKu8slice ser); + +/** + * Frees any resources used by the RouteHop, if is_owned is set and inner is non-NULL. + */ +void RouteHop_free(struct LDKRouteHop this_obj); /** * The node_id of the node at this hop. @@ -8834,11 +14631,20 @@ uint32_t RouteHop_get_cltv_expiry_delta(const struct LDKRouteHop *NONNULL_PTR th */ void RouteHop_set_cltv_expiry_delta(struct LDKRouteHop *NONNULL_PTR this_ptr, uint32_t val); +/** + * Constructs a new RouteHop given each field + */ 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); +/** + * Creates a copy of the RouteHop + */ struct LDKRouteHop RouteHop_clone(const struct LDKRouteHop *NONNULL_PTR orig); -void Route_free(struct LDKRoute this_ptr); +/** + * Frees any resources used by the Route, if is_owned is set and inner is non-NULL. + */ +void Route_free(struct LDKRoute this_obj); /** * The list of routes taken for a single (potentially-)multi-part payment. The pubkey of the @@ -8850,15 +14656,30 @@ void Route_free(struct LDKRoute this_ptr); */ void Route_set_paths(struct LDKRoute *NONNULL_PTR this_ptr, struct LDKCVec_CVec_RouteHopZZ val); +/** + * Constructs a new Route given each field + */ MUST_USE_RES struct LDKRoute Route_new(struct LDKCVec_CVec_RouteHopZZ paths_arg); +/** + * Creates a copy of the Route + */ struct LDKRoute Route_clone(const struct LDKRoute *NONNULL_PTR orig); +/** + * Serialize the Route object into a byte array which can be read by Route_read + */ struct LDKCVec_u8Z Route_write(const struct LDKRoute *NONNULL_PTR obj); +/** + * Read a Route from a byte array, created by Route_write + */ struct LDKCResult_RouteDecodeErrorZ Route_read(struct LDKu8slice ser); -void RouteHint_free(struct LDKRouteHint this_ptr); +/** + * Frees any resources used by the RouteHint, if is_owned is set and inner is non-NULL. + */ +void RouteHint_free(struct LDKRouteHint this_obj); /** * The node_id of the non-target end of the route @@ -8900,11 +14721,42 @@ uint16_t RouteHint_get_cltv_expiry_delta(const struct LDKRouteHint *NONNULL_PTR */ void RouteHint_set_cltv_expiry_delta(struct LDKRouteHint *NONNULL_PTR this_ptr, uint16_t val); +/** + * The minimum value, in msat, which must be relayed to the next hop. + */ +struct LDKCOption_u64Z RouteHint_get_htlc_minimum_msat(const struct LDKRouteHint *NONNULL_PTR this_ptr); + +/** + * The minimum value, in msat, which must be relayed to the next hop. + */ +void RouteHint_set_htlc_minimum_msat(struct LDKRouteHint *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val); + +/** + * The maximum value in msat available for routing with a single HTLC. + */ +struct LDKCOption_u64Z RouteHint_get_htlc_maximum_msat(const struct LDKRouteHint *NONNULL_PTR this_ptr); + +/** + * The maximum value in msat available for routing with a single HTLC. + */ +void RouteHint_set_htlc_maximum_msat(struct LDKRouteHint *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val); + +/** + * Constructs a new RouteHint given each field + */ +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); + +/** + * Creates a copy of the RouteHint + */ struct LDKRouteHint RouteHint_clone(const struct LDKRouteHint *NONNULL_PTR orig); /** * Gets a route from us (payer) to the given target node (payee). * + * If the payee provided features in their invoice, they should be provided via payee_features. + * Without this, MPP will only be used if the payee's features are available in the network graph. + * * Extra routing hops between known nodes and the target will be used if they are included in * last_hops. * @@ -8920,15 +14772,27 @@ struct LDKRouteHint RouteHint_clone(const struct LDKRouteHint *NONNULL_PTR orig) * equal), however the enabled/disabled bit on such channels as well as the * htlc_minimum_msat/htlc_maximum_msat *are* checked as they may change based on the receiving node. */ -struct LDKCResult_RouteLightningErrorZ get_route(struct LDKPublicKey our_node_id, const struct LDKNetworkGraph *NONNULL_PTR network, struct LDKPublicKey payee, struct LDKCVec_ChannelDetailsZ *first_hops, struct LDKCVec_RouteHintZ last_hops, uint64_t final_value_msat, uint32_t final_cltv, struct LDKLogger logger); +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); -void NetworkGraph_free(struct LDKNetworkGraph this_ptr); +/** + * Frees any resources used by the NetworkGraph, if is_owned is set and inner is non-NULL. + */ +void NetworkGraph_free(struct LDKNetworkGraph this_obj); +/** + * Creates a copy of the NetworkGraph + */ struct LDKNetworkGraph NetworkGraph_clone(const struct LDKNetworkGraph *NONNULL_PTR orig); -void LockedNetworkGraph_free(struct LDKLockedNetworkGraph this_ptr); +/** + * Frees any resources used by the LockedNetworkGraph, if is_owned is set and inner is non-NULL. + */ +void LockedNetworkGraph_free(struct LDKLockedNetworkGraph this_obj); -void NetGraphMsgHandler_free(struct LDKNetGraphMsgHandler this_ptr); +/** + * Frees any resources used by the NetGraphMsgHandler, if is_owned is set and inner is non-NULL. + */ +void NetGraphMsgHandler_free(struct LDKNetGraphMsgHandler this_obj); /** * Creates a new tracker of the actual state of the network of channels and nodes, @@ -8965,11 +14829,22 @@ MUST_USE_RES struct LDKLockedNetworkGraph NetGraphMsgHandler_read_locked_graph(c */ MUST_USE_RES struct LDKNetworkGraph LockedNetworkGraph_graph(const struct LDKLockedNetworkGraph *NONNULL_PTR this_arg); +/** + * Constructs a new RoutingMessageHandler which calls the relevant methods on this_arg. + * This copies the `inner` pointer in this_arg and thus the returned RoutingMessageHandler must be freed before this_arg is + */ struct LDKRoutingMessageHandler NetGraphMsgHandler_as_RoutingMessageHandler(const struct LDKNetGraphMsgHandler *NONNULL_PTR this_arg); +/** + * Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg. + * This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is + */ struct LDKMessageSendEventsProvider NetGraphMsgHandler_as_MessageSendEventsProvider(const struct LDKNetGraphMsgHandler *NONNULL_PTR this_arg); -void DirectionalChannelInfo_free(struct LDKDirectionalChannelInfo this_ptr); +/** + * Frees any resources used by the DirectionalChannelInfo, if is_owned is set and inner is non-NULL. + */ +void DirectionalChannelInfo_free(struct LDKDirectionalChannelInfo this_obj); /** * When the last update to the channel direction was issued. @@ -9013,6 +14888,16 @@ uint64_t DirectionalChannelInfo_get_htlc_minimum_msat(const struct LDKDirectiona */ void DirectionalChannelInfo_set_htlc_minimum_msat(struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr, uint64_t val); +/** + * The maximum value which may be relayed to the next hop via the channel. + */ +struct LDKCOption_u64Z DirectionalChannelInfo_get_htlc_maximum_msat(const struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr); + +/** + * The maximum value which may be relayed to the next hop via the channel. + */ +void DirectionalChannelInfo_set_htlc_maximum_msat(struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val); + /** * Fees charged when the channel is used for routing */ @@ -9039,13 +14924,30 @@ struct LDKChannelUpdate DirectionalChannelInfo_get_last_update_message(const str */ void DirectionalChannelInfo_set_last_update_message(struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr, struct LDKChannelUpdate val); +/** + * Constructs a new DirectionalChannelInfo given each field + */ +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); + +/** + * Creates a copy of the DirectionalChannelInfo + */ struct LDKDirectionalChannelInfo DirectionalChannelInfo_clone(const struct LDKDirectionalChannelInfo *NONNULL_PTR orig); +/** + * Serialize the DirectionalChannelInfo object into a byte array which can be read by DirectionalChannelInfo_read + */ struct LDKCVec_u8Z DirectionalChannelInfo_write(const struct LDKDirectionalChannelInfo *NONNULL_PTR obj); +/** + * Read a DirectionalChannelInfo from a byte array, created by DirectionalChannelInfo_write + */ struct LDKCResult_DirectionalChannelInfoDecodeErrorZ DirectionalChannelInfo_read(struct LDKu8slice ser); -void ChannelInfo_free(struct LDKChannelInfo this_ptr); +/** + * Frees any resources used by the ChannelInfo, if is_owned is set and inner is non-NULL. + */ +void ChannelInfo_free(struct LDKChannelInfo this_obj); /** * Protocol features of a channel communicated during its announcement @@ -9097,6 +14999,16 @@ struct LDKDirectionalChannelInfo ChannelInfo_get_two_to_one(const struct LDKChan */ void ChannelInfo_set_two_to_one(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKDirectionalChannelInfo val); +/** + * The channel capacity as seen on-chain, if chain lookup is available. + */ +struct LDKCOption_u64Z ChannelInfo_get_capacity_sats(const struct LDKChannelInfo *NONNULL_PTR this_ptr); + +/** + * The channel capacity as seen on-chain, if chain lookup is available. + */ +void ChannelInfo_set_capacity_sats(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val); + /** * An initial announcement of the channel * Mostly redundant with the data we store in fields explicitly. @@ -9113,13 +15025,30 @@ struct LDKChannelAnnouncement ChannelInfo_get_announcement_message(const struct */ void ChannelInfo_set_announcement_message(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKChannelAnnouncement val); +/** + * Constructs a new ChannelInfo given each field + */ +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); + +/** + * Creates a copy of the ChannelInfo + */ struct LDKChannelInfo ChannelInfo_clone(const struct LDKChannelInfo *NONNULL_PTR orig); +/** + * Serialize the ChannelInfo object into a byte array which can be read by ChannelInfo_read + */ struct LDKCVec_u8Z ChannelInfo_write(const struct LDKChannelInfo *NONNULL_PTR obj); +/** + * Read a ChannelInfo from a byte array, created by ChannelInfo_write + */ struct LDKCResult_ChannelInfoDecodeErrorZ ChannelInfo_read(struct LDKu8slice ser); -void RoutingFees_free(struct LDKRoutingFees this_ptr); +/** + * Frees any resources used by the RoutingFees, if is_owned is set and inner is non-NULL. + */ +void RoutingFees_free(struct LDKRoutingFees this_obj); /** * Flat routing fee in satoshis @@ -9143,15 +15072,30 @@ uint32_t RoutingFees_get_proportional_millionths(const struct LDKRoutingFees *NO */ void RoutingFees_set_proportional_millionths(struct LDKRoutingFees *NONNULL_PTR this_ptr, uint32_t val); +/** + * Constructs a new RoutingFees given each field + */ MUST_USE_RES struct LDKRoutingFees RoutingFees_new(uint32_t base_msat_arg, uint32_t proportional_millionths_arg); +/** + * Creates a copy of the RoutingFees + */ struct LDKRoutingFees RoutingFees_clone(const struct LDKRoutingFees *NONNULL_PTR orig); +/** + * Read a RoutingFees from a byte array, created by RoutingFees_write + */ struct LDKCResult_RoutingFeesDecodeErrorZ RoutingFees_read(struct LDKu8slice ser); +/** + * Serialize the RoutingFees object into a byte array which can be read by RoutingFees_read + */ struct LDKCVec_u8Z RoutingFees_write(const struct LDKRoutingFees *NONNULL_PTR obj); -void NodeAnnouncementInfo_free(struct LDKNodeAnnouncementInfo this_ptr); +/** + * Frees any resources used by the NodeAnnouncementInfo, if is_owned is set and inner is non-NULL. + */ +void NodeAnnouncementInfo_free(struct LDKNodeAnnouncementInfo this_obj); /** * Protocol features the node announced support for @@ -9220,15 +15164,30 @@ struct LDKNodeAnnouncement NodeAnnouncementInfo_get_announcement_message(const s */ void NodeAnnouncementInfo_set_announcement_message(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, struct LDKNodeAnnouncement val); +/** + * Constructs a new NodeAnnouncementInfo given each field + */ 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); +/** + * Creates a copy of the NodeAnnouncementInfo + */ struct LDKNodeAnnouncementInfo NodeAnnouncementInfo_clone(const struct LDKNodeAnnouncementInfo *NONNULL_PTR orig); +/** + * Serialize the NodeAnnouncementInfo object into a byte array which can be read by NodeAnnouncementInfo_read + */ struct LDKCVec_u8Z NodeAnnouncementInfo_write(const struct LDKNodeAnnouncementInfo *NONNULL_PTR obj); +/** + * Read a NodeAnnouncementInfo from a byte array, created by NodeAnnouncementInfo_write + */ struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ NodeAnnouncementInfo_read(struct LDKu8slice ser); -void NodeInfo_free(struct LDKNodeInfo this_ptr); +/** + * Frees any resources used by the NodeInfo, if is_owned is set and inner is non-NULL. + */ +void NodeInfo_free(struct LDKNodeInfo this_obj); /** * All valid channels a node has announced @@ -9263,16 +15222,34 @@ struct LDKNodeAnnouncementInfo NodeInfo_get_announcement_info(const struct LDKNo */ void NodeInfo_set_announcement_info(struct LDKNodeInfo *NONNULL_PTR this_ptr, struct LDKNodeAnnouncementInfo val); +/** + * Constructs a new NodeInfo given each field + */ MUST_USE_RES struct LDKNodeInfo NodeInfo_new(struct LDKCVec_u64Z channels_arg, struct LDKRoutingFees lowest_inbound_channel_fees_arg, struct LDKNodeAnnouncementInfo announcement_info_arg); +/** + * Creates a copy of the NodeInfo + */ struct LDKNodeInfo NodeInfo_clone(const struct LDKNodeInfo *NONNULL_PTR orig); +/** + * Serialize the NodeInfo object into a byte array which can be read by NodeInfo_read + */ struct LDKCVec_u8Z NodeInfo_write(const struct LDKNodeInfo *NONNULL_PTR obj); +/** + * Read a NodeInfo from a byte array, created by NodeInfo_write + */ struct LDKCResult_NodeInfoDecodeErrorZ NodeInfo_read(struct LDKu8slice ser); +/** + * Serialize the NetworkGraph object into a byte array which can be read by NetworkGraph_read + */ struct LDKCVec_u8Z NetworkGraph_write(const struct LDKNetworkGraph *NONNULL_PTR obj); +/** + * Read a NetworkGraph from a byte array, created by NetworkGraph_write + */ struct LDKCResult_NetworkGraphDecodeErrorZ NetworkGraph_read(struct LDKu8slice ser); /**