Add comment

ACINQ · Jan 22, 2025 · 98cc265 · 98cc265
1 parent ba13ced
commit 98cc265
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/eclair-core/src/main/scala/fr/acinq/eclair/wire/protocol/OfferTypes.scala b/eclair-core/src/main/scala/fr/acinq/eclair/wire/protocol/OfferTypes.scala
@@ -314,6 +314,10 @@ object OfferTypes {
       Right(Offer(records))
     }
 
+    /**
+     * An offer string can be split with '+' to fit in places with a low character limit. This validates that the string adheres to the spec format to guard against copy-pasting errors.
+     * @return a lowercase string with '+' and whitespaces removed
+     */
     def validateFormat(s: String): String = {
       val lowercase = s.toLowerCase
       require(s == lowercase || s == s.toUpperCase)