Merge pull request #1558 from get10101/chore/document-reason-for-patch

Document reason for patched version of `rust-dlc`

Cargo.toml

@@ -16,7 +16,12 @@ default-members = [
 resolver = "2"
 
 [patch.crates-io]
-# We should usually track the `p2pderivatives/feature/ln-dlc-channels[-10101]` branch
+# We should usually track the `p2pderivatives/feature/ln-dlc-channels[-10101]` branch.
+#
+# We are currently depending on one patch that will _not_ be merged into
+# `p2pderivatives/rust-dlc#feature/ln-dlc-channels`: 4e104b4. This patch ensures backwards
+# compatibility for 10101 through the `rust-lightning:0.0.116` upgrade. We will be able to drop it
+# once all users have been upgraded and traded once.
 dlc-manager = { git = "https://github.com/p2pderivatives/rust-dlc", rev = "4e104b4" }
 dlc-messages = { git = "https://github.com/p2pderivatives/rust-dlc", rev = "4e104b4" }
 dlc = { git = "https://github.com/p2pderivatives/rust-dlc", rev = "4e104b4" }
@@ -25,7 +30,7 @@ p2pd-oracle-client = { git = "https://github.com/p2pderivatives/rust-dlc", rev =
 dlc-trie = { git = "https://github.com/p2pderivatives/rust-dlc", rev = "4e104b4" }
 simple-wallet = { git = "https://github.com/p2pderivatives/rust-dlc", rev = "4e104b4" }
 
-# We should usually track the `p2pderivatives/split-tx-experiment[-10101]` branch
+# We should usually track the `p2pderivatives/split-tx-experiment[-10101]` branch.
 lightning = { git = "https://github.com/p2pderivatives/rust-lightning/", rev = "a57281b" }
 lightning-background-processor = { git = "https://github.com/p2pderivatives/rust-lightning/", rev = "a57281b" }
 lightning-transaction-sync = { git = "https://github.com/p2pderivatives/rust-lightning/", rev = "a57281b" }
@@ -34,7 +39,7 @@ lightning-persister = { git = "https://github.com/p2pderivatives/rust-lightning/
 
 rust-bitcoin-coin-selection = { git = "https://github.com/p2pderivatives/rust-bitcoin-coin-selection" }
 
-# Waiting for the next release
+# Waiting for the next release.
 xtra = { git = "https://github.com/Restioson/xtra/", rev = "d98393a" }
 
 [profile.test.package.proptest]