Merge pull request #139 from TheBlueMatt/main

LDK 0.0.117

Author: TheBlueMatt

.github/workflows/build.yml

@@ -38,13 +38,15 @@ jobs:
           git config --global user.email "[email protected]"
           git config --global user.name "LDK CI"
           # Note this is a different endpoint, as we need one non-upstream commit!
-          git clone https://git.bitcoin.ninja/rust-lightning
+          git clone https://github.com/lightningdevkit/rust-lightning
           cd rust-lightning
-          git checkout origin/2023-07-0.0.116-java-bindings
+          git checkout origin/0.0.117-bindings
           cd ..
           git clone https://github.com/lightningdevkit/ldk-c-bindings
           cd ldk-c-bindings
-          git checkout 0.0.116
+          git checkout 0.0.117
+          cd lightning-c-bindings
+          cargo update -p memchr --precise "2.5.0" --verbose
       - name: Rebuild C bindings without STD
         run: |
           cd ldk-c-bindings
@@ -132,13 +134,15 @@ jobs:
           git config --global user.email "[email protected]"
           git config --global user.name "LDK CI"
           # Note this is a different endpoint, as we need one non-upstream commit!
-          git clone https://git.bitcoin.ninja/rust-lightning
+          git clone https://github.com/lightningdevkit/rust-lightning
           cd rust-lightning
-          git checkout origin/2023-07-0.0.116-java-bindings
+          git checkout origin/0.0.117-bindings
           cd ..
           git clone https://github.com/lightningdevkit/ldk-c-bindings
           cd ldk-c-bindings
-          git checkout 0.0.116
+          git checkout 0.0.117
+          cd lightning-c-bindings
+          cargo update -p memchr --precise "2.5.0" --verbose
       - name: Pin proc-macro and quote to meet MSRV
         run: |
           cd ldk-c-bindings/c-bindings-gen
@@ -193,13 +197,15 @@ jobs:
           git config --global user.email "[email protected]"
           git config --global user.name "LDK CI"
           # Note this is a different endpoint, as we need one non-upstream commit!
-          git clone https://git.bitcoin.ninja/rust-lightning
+          git clone https://github.com/lightningdevkit/rust-lightning
           cd rust-lightning
-          git checkout origin/2023-07-0.0.116-java-bindings
+          git checkout origin/0.0.117-bindings
           cd ..
           git clone https://github.com/lightningdevkit/ldk-c-bindings
           cd ldk-c-bindings
-          git checkout 0.0.116
+          git checkout 0.0.117
+          cd lightning-c-bindings
+          cargo update -p memchr --precise "2.5.0" --verbose
       - name: Pin proc-macro and quote to meet MSRV
         run: |
           cd ldk-c-bindings/c-bindings-gen
@@ -308,13 +314,13 @@ jobs:
           git config --global user.email "[email protected]"
           git config --global user.name "LDK CI"
           # Note this is a different endpoint, as we need one non-upstream commit!
-          git clone https://git.bitcoin.ninja/rust-lightning
+          git clone https://github.com/lightningdevkit/rust-lightning
           cd rust-lightning
-          git checkout origin/2023-07-0.0.116-java-bindings
+          git checkout origin/0.0.117-bindings
           cd ..
           git clone https://github.com/lightningdevkit/ldk-c-bindings
           cd ldk-c-bindings
-          git checkout 0.0.116
+          git checkout 0.0.117
       - name: Fetch MacOS SDK
         run: |
           curl -o Xcode-12.2-12B45b-extracted-SDK-with-libcxx-headers.tar.gz https://bitcoincore.org/depends-sources/sdks/Xcode-12.2-12B45b-extracted-SDK-with-libcxx-headers.tar.gz
@@ -445,13 +451,15 @@ jobs:
           git config --global user.email "[email protected]"
           git config --global user.name "LDK CI"
           # Note this is a different endpoint, as we need one non-upstream commit!
-          git clone https://git.bitcoin.ninja/rust-lightning
+          git clone https://github.com/lightningdevkit/rust-lightning
           cd rust-lightning
-          git checkout origin/2023-07-0.0.116-java-bindings
+          git checkout origin/0.0.117-bindings
           cd ..
           git clone https://github.com/lightningdevkit/ldk-c-bindings
           cd ldk-c-bindings
-          git checkout 0.0.116
+          git checkout 0.0.117
+          cd lightning-c-bindings
+          cargo update -p memchr --precise "2.5.0" --verbose
       - name: Checkout Android AAR binaries and artifacts
         run: |
           # Gitweb only allows snapshots of folders by providing the object hash, which we have to extract:
@@ -518,13 +526,15 @@ jobs:
           git config --global user.email "[email protected]"
           git config --global user.name "LDK CI"
           # Note this is a different endpoint, as we need one non-upstream commit!
-          git clone https://git.bitcoin.ninja/rust-lightning
+          git clone https://github.com/rghtningdevkit/ust-lightning
           cd rust-lightning
-          git checkout origin/2023-07-0.0.116-java-bindings
+          git checkout origin/0.0.117-bindings
           cd ..
           git clone https://github.com/lightningdevkit/ldk-c-bindings
           cd ldk-c-bindings
-          git checkout 0.0.116
+          git checkout 0.0.117
+          cd lightning-c-bindings
+          cargo update -p memchr --precise "2.5.0" --verbose
       - name: Rebuild C bindings and check the sample app builds + links
         run: |
           cd ldk-c-bindings

README.md

@@ -41,22 +41,13 @@ Status
 
 ## Java
 
-While the underlying library and C bindings are relatively mature, the Java bindings should be
-considered beta quality and some issues may still appear. Specifically, because the Java bindings
-map between two very different memory models - Rust's strict ownership model and Java's reference
-cloning and garbage collection - a lot of work occurs in the background to keep the Java GC
-informed of Rust ownership semantics.
-
-The debug-mode build includes memory leak tracking and will print all loose objects when the
-program exists, though without calls to `System.gc(); System.runFinalization();` immediately before
-exit there will likely be many false positives. While it will require some complicated usage, there
-are likely some use-after-free or unkonwn-free bugs remaining. The debug-mode build links LLVM
-address sanitizer and will print diagnostic information in case of such issues.
+The Java bindings are relatively mature, and should be considered safe for production use. Still,
+as they have relatively few users, unexpected issues remain possible, and bug reports are welcome.
 
 ## TypeScript
 
-The TypeScript bindings are functionally complete, but should be considered early alpha quality.
-Some functions may error spuriously due to oversights or missing implementations.
+The TypeScript bindings are functionally complete, but should be considered beta quality. As there
+are relatively few users, unexpected issues remain likely, and bug reports are welcome.
 
 The TypeScript bindings require modern web standards, including support for `FinalizationRegistry`
 and `WeakRef` (Chrome 84, Firefox 79, Safari 14.1/iOS 14.5 and Node 14.6) and WASM BigInt support

c_sharp/src/org/ldk/enums/SemanticError.cs renamed to c_sharp/src/org/ldk/enums/Bolt11SemanticError.cs

@@ -1,47 +1,47 @@
 namespace org { namespace ldk { namespace enums {/**
- * Errors that may occur when converting a `RawInvoice` to an `Invoice`. They relate to the
- * requirements sections in BOLT #11
+ * Errors that may occur when converting a [`RawBolt11Invoice`] to a [`Bolt11Invoice`]. They relate to
+ * the requirements sections in BOLT #11
  */
-public enum SemanticError {
+public enum Bolt11SemanticError {
 	/**
 	 * The invoice is missing the mandatory payment hash
 	 */
-	LDKSemanticError_NoPaymentHash,
+	LDKBolt11SemanticError_NoPaymentHash,
 	/**
 	 * The invoice has multiple payment hashes which isn't allowed
 	 */
-	LDKSemanticError_MultiplePaymentHashes,
+	LDKBolt11SemanticError_MultiplePaymentHashes,
 	/**
 	 * No description or description hash are part of the invoice
 	 */
-	LDKSemanticError_NoDescription,
+	LDKBolt11SemanticError_NoDescription,
 	/**
 	 * The invoice contains multiple descriptions and/or description hashes which isn't allowed
 	 */
-	LDKSemanticError_MultipleDescriptions,
+	LDKBolt11SemanticError_MultipleDescriptions,
 	/**
 	 * The invoice is missing the mandatory payment secret, which all modern lightning nodes
 	 * should provide.
 	 */
-	LDKSemanticError_NoPaymentSecret,
+	LDKBolt11SemanticError_NoPaymentSecret,
 	/**
 	 * The invoice contains multiple payment secrets
 	 */
-	LDKSemanticError_MultiplePaymentSecrets,
+	LDKBolt11SemanticError_MultiplePaymentSecrets,
 	/**
 	 * The invoice's features are invalid
 	 */
-	LDKSemanticError_InvalidFeatures,
+	LDKBolt11SemanticError_InvalidFeatures,
 	/**
 	 * The recovery id doesn't fit the signature/pub key
 	 */
-	LDKSemanticError_InvalidRecoveryId,
+	LDKBolt11SemanticError_InvalidRecoveryId,
 	/**
 	 * The invoice's signature is invalid
 	 */
-	LDKSemanticError_InvalidSignature,
+	LDKBolt11SemanticError_InvalidSignature,
 	/**
 	 * The invoice's amount was not a whole number of millisatoshis
 	 */
-	LDKSemanticError_ImpreciseAmount,
+	LDKBolt11SemanticError_ImpreciseAmount,
 }} } }

c_sharp/src/org/ldk/enums/Bolt12SemanticError.cs

@@ -0,0 +1,109 @@
+namespace org { namespace ldk { namespace enums {/**
+ * Error when interpreting a TLV stream as a specific type.
+ */
+public enum Bolt12SemanticError {
+	/**
+	 * The current [`std::time::SystemTime`] is past the offer or invoice's expiration.
+	 */
+	LDKBolt12SemanticError_AlreadyExpired,
+	/**
+	 * The provided chain hash does not correspond to a supported chain.
+	 */
+	LDKBolt12SemanticError_UnsupportedChain,
+	/**
+	 * A chain was provided but was not expected.
+	 */
+	LDKBolt12SemanticError_UnexpectedChain,
+	/**
+	 * An amount was expected but was missing.
+	 */
+	LDKBolt12SemanticError_MissingAmount,
+	/**
+	 * The amount exceeded the total bitcoin supply.
+	 */
+	LDKBolt12SemanticError_InvalidAmount,
+	/**
+	 * An amount was provided but was not sufficient in value.
+	 */
+	LDKBolt12SemanticError_InsufficientAmount,
+	/**
+	 * An amount was provided but was not expected.
+	 */
+	LDKBolt12SemanticError_UnexpectedAmount,
+	/**
+	 * A currency was provided that is not supported.
+	 */
+	LDKBolt12SemanticError_UnsupportedCurrency,
+	/**
+	 * A feature was required but is unknown.
+	 */
+	LDKBolt12SemanticError_UnknownRequiredFeatures,
+	/**
+	 * Features were provided but were not expected.
+	 */
+	LDKBolt12SemanticError_UnexpectedFeatures,
+	/**
+	 * A required description was not provided.
+	 */
+	LDKBolt12SemanticError_MissingDescription,
+	/**
+	 * A signing pubkey was not provided.
+	 */
+	LDKBolt12SemanticError_MissingSigningPubkey,
+	/**
+	 * A signing pubkey was provided but a different one was expected.
+	 */
+	LDKBolt12SemanticError_InvalidSigningPubkey,
+	/**
+	 * A signing pubkey was provided but was not expected.
+	 */
+	LDKBolt12SemanticError_UnexpectedSigningPubkey,
+	/**
+	 * A quantity was expected but was missing.
+	 */
+	LDKBolt12SemanticError_MissingQuantity,
+	/**
+	 * An unsupported quantity was provided.
+	 */
+	LDKBolt12SemanticError_InvalidQuantity,
+	/**
+	 * A quantity or quantity bounds was provided but was not expected.
+	 */
+	LDKBolt12SemanticError_UnexpectedQuantity,
+	/**
+	 * Metadata could not be used to verify the offers message.
+	 */
+	LDKBolt12SemanticError_InvalidMetadata,
+	/**
+	 * Metadata was provided but was not expected.
+	 */
+	LDKBolt12SemanticError_UnexpectedMetadata,
+	/**
+	 * Payer metadata was expected but was missing.
+	 */
+	LDKBolt12SemanticError_MissingPayerMetadata,
+	/**
+	 * A payer id was expected but was missing.
+	 */
+	LDKBolt12SemanticError_MissingPayerId,
+	/**
+	 * Blinded paths were expected but were missing.
+	 */
+	LDKBolt12SemanticError_MissingPaths,
+	/**
+	 * The blinded payinfo given does not match the number of blinded path hops.
+	 */
+	LDKBolt12SemanticError_InvalidPayInfo,
+	/**
+	 * An invoice creation time was expected but was missing.
+	 */
+	LDKBolt12SemanticError_MissingCreationTime,
+	/**
+	 * An invoice payment hash was expected but was missing.
+	 */
+	LDKBolt12SemanticError_MissingPaymentHash,
+	/**
+	 * A signature was expected but was missing.
+	 */
+	LDKBolt12SemanticError_MissingSignature,
+}} } }

c_sharp/src/org/ldk/enums/ChannelShutdownState.cs

@@ -0,0 +1,32 @@
+namespace org { namespace ldk { namespace enums {/**
+ * Further information on the details of the channel shutdown.
+ * Upon channels being forced closed (i.e. commitment transaction confirmation detected
+ * by `ChainMonitor`), ChannelShutdownState will be set to `ShutdownComplete` or
+ * the channel will be removed shortly.
+ * Also note, that in normal operation, peers could disconnect at any of these states
+ * and require peer re-connection before making progress onto other states
+ */
+public enum ChannelShutdownState {
+	/**
+	 * Channel has not sent or received a shutdown message.
+	 */
+	LDKChannelShutdownState_NotShuttingDown,
+	/**
+	 * Local node has sent a shutdown message for this channel.
+	 */
+	LDKChannelShutdownState_ShutdownInitiated,
+	/**
+	 * Shutdown message exchanges have concluded and the channels are in the midst of
+	 * resolving all existing open HTLCs before closing can continue.
+	 */
+	LDKChannelShutdownState_ResolvingHTLCs,
+	/**
+	 * All HTLCs have been resolved, nodes are currently negotiating channel close onchain fee rates.
+	 */
+	LDKChannelShutdownState_NegotiatingClosingFee,
+	/**
+	 * We've successfully negotiated a closing_signed dance. At this point `ChannelManager` is about
+	 * to drop the channel.
+	 */
+	LDKChannelShutdownState_ShutdownComplete,
+}} } }

c_sharp/src/org/ldk/enums/ConfirmationTarget.cs

@@ -1,18 +1,29 @@
 namespace org { namespace ldk { namespace enums {/**
- * An enum that represents the speed at which we want a transaction to confirm used for feerate
+ * An enum that represents the priority at which we want a transaction to confirm used for feerate
  * estimation.
  */
 public enum ConfirmationTarget {
 	/**
-	 * We are happy with this transaction confirming slowly when feerate drops some.
+	 * We'd like a transaction to confirm in the future, but don't want to commit most of the fees
+	 * required to do so yet. The remaining fees will come via a Child-Pays-For-Parent (CPFP) fee
+	 * bump of the transaction.
+	 * 
+	 * The feerate returned should be the absolute minimum feerate required to enter most node
+	 * mempools across the network. Note that if you are not able to obtain this feerate estimate,
+	 * you should likely use the furthest-out estimate allowed by your fee estimator.
+	 */
+	LDKConfirmationTarget_MempoolMinimum,
+	/**
+	 * We are happy with a transaction confirming slowly, at least within a day or so worth of
+	 * blocks.
 	 */
 	LDKConfirmationTarget_Background,
 	/**
-	 * We'd like this transaction to confirm without major delay, but 12-18 blocks is fine.
+	 * We'd like a transaction to confirm without major delayed, i.e., within the next 12-24 blocks.
 	 */
 	LDKConfirmationTarget_Normal,
 	/**
-	 * We'd like this transaction to confirm in the next few blocks.
+	 * We'd like a transaction to confirm in the next few blocks.
 	 */
 	LDKConfirmationTarget_HighPriority,
 }} } }

c_sharp/src/org/ldk/enums/CreationError.cs

@@ -1,9 +1,9 @@
 namespace org { namespace ldk { namespace enums {/**
- * Errors that may occur when constructing a new `RawInvoice` or `Invoice`
+ * Errors that may occur when constructing a new [`RawBolt11Invoice`] or [`Bolt11Invoice`]
  */
 public enum CreationError {
 	/**
-	 * The supplied description string was longer than 639 __bytes__ (see [`Description::new(...)`](./struct.Description.html#method.new))
+	 * The supplied description string was longer than 639 __bytes__ (see [`Description::new`])
 	 */
 	LDKCreationError_DescriptionTooLong,
 	/**
@@ -25,4 +25,10 @@ public enum CreationError {
 	 * [phantom invoices]: crate::utils::create_phantom_invoice
 	 */
 	LDKCreationError_MissingRouteHints,
+	/**
+	 * The provided `min_final_cltv_expiry_delta` was less than [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
+	 * 
+	 * [`MIN_FINAL_CLTV_EXPIRY_DELTA`]: lightning::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA
+	 */
+	LDKCreationError_MinFinalCltvExpiryDeltaTooShort,
 }} } }