Revert serializable FinalFailure (#241)

Changes from cba7e7e are reverted. If Phoenix needs to serialize objects 
from eclair-kmp, it should handle that itself. Eclair-kmp does not need to 
know about it.

ChannelClosingType hierarchy is also simplified.

Author: dpad85

src/commonMain/kotlin/fr/acinq/eclair/channel/Channel.kt

@@ -16,7 +16,7 @@ import fr.acinq.eclair.channel.Helpers.Closing.overriddenOutgoingHtlcs
 import fr.acinq.eclair.channel.Helpers.Closing.timedOutHtlcs
 import fr.acinq.eclair.crypto.KeyManager
 import fr.acinq.eclair.crypto.ShaChain
-import fr.acinq.eclair.db.OutgoingPayment.Status.Completed.Succeeded.OnChain.ChannelClosingType
+import fr.acinq.eclair.db.ChannelClosingType
 import fr.acinq.eclair.router.Announcements
 import fr.acinq.eclair.serialization.Serialization
 import fr.acinq.eclair.transactions.CommitmentSpec
@@ -97,7 +97,7 @@ sealed class ChannelAction {
         data class GetHtlcInfos(val revokedCommitTxId: ByteVector32, val commitmentNumber: Long) : Storage()
         data class StoreIncomingAmount(val amount: MilliSatoshi, val origin: ChannelOrigin?) : Storage()
         data class StoreChannelClosing(val amount: MilliSatoshi, val closingAddress: String, val isSentToDefaultAddress: Boolean) : Storage()
-        data class StoreChannelClosed(val txids: List<ByteVector32>, val claimed: Satoshi, val type: ChannelClosingType) : Storage()
+        data class StoreChannelClosed(val txids: List<ByteVector32>, val claimed: Satoshi, val closingType: ChannelClosingType) : Storage()
     }
 
     data class ProcessIncomingHtlc(val add: UpdateAddHtlc) : ChannelAction()

src/commonMain/kotlin/fr/acinq/eclair/db/PaymentsDb.kt

@@ -11,6 +11,7 @@ import fr.acinq.eclair.payment.FinalFailure
 import fr.acinq.eclair.payment.PaymentRequest
 import fr.acinq.eclair.utils.*
 import fr.acinq.eclair.wire.FailureMessage
+import kotlinx.serialization.Serializable
 
 interface PaymentsDb : IncomingPaymentsDb, OutgoingPaymentsDb {
     /** List sent and received payments (with most recent payments first). */
@@ -226,13 +227,9 @@ data class OutgoingPayment(val id: UUID, val recipientAmount: MilliSatoshi, val
                     // In the future, we plan on storing the closing btc transactions as parts.
                     // Then we can use those parts to calculate the fees, and provide more details to the user.
                     val claimed: Satoshi,
-                    val type: ChannelClosingType,
+                    val closingType: ChannelClosingType,
                     override val completedAt: Long = currentTimestampMillis()
-                ) : Succeeded() {
-                    enum class ChannelClosingType {
-                        Mutual, Local, Remote, Revoked, Other
-                    }
-                }
+                ) : Succeeded()
             }
         }
     }
@@ -262,6 +259,10 @@ data class OutgoingPayment(val id: UUID, val recipientAmount: MilliSatoshi, val
     }
 }
 
+enum class ChannelClosingType {
+    Mutual, Local, Remote, Revoked, Other;
+}
+
 data class HopDesc(val nodeId: PublicKey, val nextNodeId: PublicKey, val shortChannelId: ShortChannelId? = null) {
     override fun toString(): String = when (shortChannelId) {
         null -> "$nodeId->$nextNodeId"

src/commonMain/kotlin/fr/acinq/eclair/io/Peer.kt

@@ -427,7 +427,7 @@ class Peer(
                 }
                 action is ChannelAction.Storage.StoreChannelClosed -> {
                     val dbId = UUID.fromBytes(channelId.take(16).toByteArray())
-                    val completed = OutgoingPayment.Status.Completed.Succeeded.OnChain(action.txids, action.claimed, action.type)
+                    val completed = OutgoingPayment.Status.Completed.Succeeded.OnChain(action.txids, action.claimed, action.closingType)
                     db.payments.completeOutgoingPayment(dbId, completed)
                     listenerEventChannel.send(ChannelClosing(channelId))
                 }

src/commonMain/kotlin/fr/acinq/eclair/payment/OutgoingPaymentFailure.kt

@@ -5,25 +5,23 @@ import fr.acinq.eclair.db.OutgoingPayment
 import fr.acinq.eclair.utils.Either
 import fr.acinq.eclair.utils.currentTimestampMillis
 import fr.acinq.eclair.wire.*
-import kotlinx.serialization.Serializable
 
 /** A fatal failure that stops payment attempts. */
-@Serializable
 sealed class FinalFailure {
 
     /** Use this function when no payment attempts have been made (e.g. when a precondition failed). */
     fun toPaymentFailure(): OutgoingPaymentFailure = OutgoingPaymentFailure(this, listOf<OutgoingPayment.Part.Status.Failed>())
 
     // @formatter:off
-    @Serializable object InvalidPaymentAmount : FinalFailure() { override fun toString(): String = "payment amount must be positive" }
-    @Serializable object InvalidPaymentId : FinalFailure() { override fun toString(): String = "payment ID must be unique" }
-    @Serializable object NoAvailableChannels : FinalFailure() { override fun toString(): String = "no channels available to send payment" }
-    @Serializable object InsufficientBalance : FinalFailure() { override fun toString(): String = "not enough funds in wallet to afford payment" }
-    @Serializable object NoRouteToRecipient : FinalFailure() { override fun toString(): String = "unable to route payment to recipient" }
-    @Serializable object RecipientUnreachable : FinalFailure() { override fun toString(): String = "the recipient was offline or did not have enough liquidity to receive the payment" }
-    @Serializable object RetryExhausted: FinalFailure() { override fun toString(): String = "payment attempts exhausted without success" }
-    @Serializable object WalletRestarted: FinalFailure() { override fun toString(): String = "wallet restarted while a payment was ongoing" }
-    @Serializable object UnknownError : FinalFailure() { override fun toString(): String = "an unknown error occurred" }
+    object InvalidPaymentAmount : FinalFailure() { override fun toString(): String = "payment amount must be positive" }
+    object InvalidPaymentId : FinalFailure() { override fun toString(): String = "payment ID must be unique" }
+    object NoAvailableChannels : FinalFailure() { override fun toString(): String = "no channels available to send payment" }
+    object InsufficientBalance : FinalFailure() { override fun toString(): String = "not enough funds in wallet to afford payment" }
+    object NoRouteToRecipient : FinalFailure() { override fun toString(): String = "unable to route payment to recipient" }
+    object RecipientUnreachable : FinalFailure() { override fun toString(): String = "the recipient was offline or did not have enough liquidity to receive the payment" }
+    object RetryExhausted: FinalFailure() { override fun toString(): String = "payment attempts exhausted without success" }
+    object WalletRestarted: FinalFailure() { override fun toString(): String = "wallet restarted while a payment was ongoing" }
+    object UnknownError : FinalFailure() { override fun toString(): String = "an unknown error occurred" }
     // @formatter:on
 }
 

src/commonTest/kotlin/fr/acinq/eclair/channel/states/ClosingTestsCommon.kt

@@ -20,7 +20,7 @@ import fr.acinq.eclair.channel.TestsHelper.mutualClose
 import fr.acinq.eclair.channel.TestsHelper.processEx
 import fr.acinq.eclair.channel.TestsHelper.reachNormal
 import fr.acinq.eclair.channel.TestsHelper.remoteClose
-import fr.acinq.eclair.db.OutgoingPayment.Status.Completed.Succeeded.OnChain.ChannelClosingType
+import fr.acinq.eclair.db.ChannelClosingType
 import fr.acinq.eclair.tests.TestConstants
 import fr.acinq.eclair.tests.utils.EclairTestSuite
 import fr.acinq.eclair.transactions.Scripts
@@ -111,7 +111,7 @@ class ClosingTestsCommon : EclairTestSuite() {
         assertTrue { alice6 is Closed }
         val storeChannelClosed = aliceActions6.filterIsInstance<ChannelAction.Storage.StoreChannelClosed>().firstOrNull()
         assertNotNull(storeChannelClosed)
-        assertTrue { storeChannelClosed.type == ChannelClosingType.Mutual }
+        assertTrue { storeChannelClosed.closingType == ChannelClosingType.Mutual }
         assertTrue { storeChannelClosed.txids == listOf(mutualCloseTx.tx.txid) }
     }
 
@@ -125,7 +125,7 @@ class ClosingTestsCommon : EclairTestSuite() {
         assertTrue { alice1 is Closed }
         val storeChannelClosed = actions1.filterIsInstance<ChannelAction.Storage.StoreChannelClosed>().firstOrNull()
         assertNotNull(storeChannelClosed)
-        assertTrue { storeChannelClosed.type == ChannelClosingType.Mutual }
+        assertTrue { storeChannelClosed.closingType == ChannelClosingType.Mutual }
         assertTrue { storeChannelClosed.txids == listOf(mutualCloseTx.tx.txid) }
     }
 
@@ -222,7 +222,7 @@ class ClosingTestsCommon : EclairTestSuite() {
         )
         val storeChannelClosed = actions.filterIsInstance<ChannelAction.Storage.StoreChannelClosed>().firstOrNull()
         assertNotNull(storeChannelClosed)
-        assertTrue { storeChannelClosed.type == ChannelClosingType.Local }
+        assertTrue { storeChannelClosed.closingType == ChannelClosingType.Local }
         assertTrue {
             storeChannelClosed.txids.toSet() ==
             listOfNotNull(
@@ -564,7 +564,7 @@ class ClosingTestsCommon : EclairTestSuite() {
         assertTrue(actions.contains(ChannelAction.Storage.StoreState(aliceClosed)))
         val storeChannelClosed = actions.filterIsInstance<ChannelAction.Storage.StoreChannelClosed>().firstOrNull()
         assertNotNull(storeChannelClosed)
-        assertTrue { storeChannelClosed.type == ChannelClosingType.Remote }
+        assertTrue { storeChannelClosed.closingType == ChannelClosingType.Remote }
         assertTrue {
             storeChannelClosed.txids.toSet() ==
             listOfNotNull(
@@ -1142,7 +1142,7 @@ class ClosingTestsCommon : EclairTestSuite() {
         )
         val storeChannelClosed = aliceActions5.filterIsInstance<ChannelAction.Storage.StoreChannelClosed>().firstOrNull()
         assertNotNull(storeChannelClosed)
-        assertTrue { storeChannelClosed.type == ChannelClosingType.Remote }
+        assertTrue { storeChannelClosed.closingType == ChannelClosingType.Remote }
         assertTrue { storeChannelClosed.txids.toSet() == aliceTxs.map { it.txid }.toSet() }
     }