Initial migration to KFSM v2 (#104)

* Initial migration to KFSM v2

* Address review comments

Author: ametke

build.gradle.kts

@@ -9,7 +9,7 @@ plugins {
   alias(libs.plugins.versionsGradlePlugin)
   alias(libs.plugins.versionCatalogUpdateGradlePlugin)
   alias(libs.plugins.kotlinBinaryCompatibilityPlugin) apply false
-  id("com.vanniktech.maven.publish") version "0.36.0" apply false
+  alias(libs.plugins.mavenPublish) apply false
 }
 
 subprojects {

…ity/outie/client/BitcoinAccountClient.kt …ty/common/client/BitcoinAccountClient.ktoutie/src/main/kotlin/xyz/block/bittycity/outie/client/BitcoinAccountClient.kt renamed to common/src/main/kotlin/xyz/block/bittycity/common/client/BitcoinAccountClient.kt outie/src/main/kotlin/xyz/block/bittycity/outie/client/BitcoinAccountClient.kt renamed to common/src/main/kotlin/xyz/block/bittycity/common/client/BitcoinAccountClient.kt

@@ -1,6 +1,6 @@
-package xyz.block.bittycity.outie.client
+package xyz.block.bittycity.common.client
 
-import xyz.block.bittycity.outie.models.BitcoinAccount
+import xyz.block.bittycity.common.models.BitcoinAccount
 import xyz.block.bittycity.common.models.CustomerId
 
 interface BitcoinAccountClient {

…lock/bittycity/outie/models/BalanceId.kt …ock/bittycity/common/models/BalanceId.ktoutie/src/main/kotlin/xyz/block/bittycity/outie/models/BalanceId.kt renamed to common/src/main/kotlin/xyz/block/bittycity/common/models/BalanceId.kt outie/src/main/kotlin/xyz/block/bittycity/outie/models/BalanceId.kt renamed to common/src/main/kotlin/xyz/block/bittycity/common/models/BalanceId.kt

@@ -1,4 +1,4 @@
-package xyz.block.bittycity.outie.models
+package xyz.block.bittycity.common.models
 
 data class BalanceId(val id: String) {
   override fun toString() = id

common/src/main/kotlin/xyz/block/bittycity/common/models/BitcoinAccount.kt

@@ -0,0 +1,7 @@
+package xyz.block.bittycity.common.models
+
+data class BitcoinAccount(
+  val customerId: CustomerId,
+  val balanceId: BalanceId,
+  val currencyDisplayPreference: CurrencyDisplayPreference
+)

gradle/libs.versions.toml

@@ -1,17 +1,21 @@
 [versions]
 arrow = "2.2.1"
 bitcoinj = "0.17"
-domainApi = "0.4.0"
+domainApi = "0.5.3"
+domainApiKfsm = "0.5.3"
+domainApiKfsmv2 = "0.1.0"
 guice = "7.0.0"
 jodaMoney = "1.0.7"
 kfsm = "0.12.0"
+kfsmv2 = "2.0.0"
 kotest = "5.9.1"
+kotlinxCoroutines = "1.10.2"
 kotestArrow = "2.0.0"
 # @pin
 kotlin = "2.2.21"
 kotlinBinaryCompatibilityPlugin = "0.18.1"
 kotlinLogging = "7.0.14"
-mavenPublish = "0.36.0"
+mavenPublish = "0.35.0"
 mockk = "1.14.7"
 moshi = "1.15.2"
 quiver = "1.0.3"
@@ -24,18 +28,22 @@ versionsGradlePlugin = "0.53.0"
 arrowCore = { module = "io.arrow-kt:arrow-core", version.ref = "arrow" }
 bitcoinj = { module = "org.bitcoinj:bitcoinj-core", version.ref = "bitcoinj" }
 domainApi = { module = "xyz.block.domainapi:domain-api", version.ref = "domainApi" }
+domainApiKfsm = { module = "xyz.block.domainapi:domain-api-kfsm", version.ref = "domainApiKfsm" }
+domainApiKfsmv2 = { module = "xyz.block.domainapi:domain-api-kfsm-v2", version.ref = "domainApiKfsmv2" }
 guice = { module = "com.google.inject:guice", version.ref = "guice" }
 guiceAssistedInject = { module = "com.google.inject.extensions:guice-assistedinject", version.ref = "guice" }
 jodaMoney = { module = "org.joda:joda-money", version.ref = "jodaMoney" }
 junitJupiter = { module = "org.junit.jupiter:junit-jupiter", version = "5.14.2" }
 kfsm = { module = "app.cash.kfsm:kfsm", version.ref = "kfsm" }
+kfsmv2 = { module = "app.cash.kfsm:kfsm-v2", version.ref = "kfsmv2" }
 kotestAssertions = { module = "io.kotest:kotest-assertions-core", version.ref = "kotest" }
 kotestAssertionsArrow = { module = "io.kotest.extensions:kotest-assertions-arrow", version.ref = "kotestArrow" }
 kotestAssertionsArrowJvm = { module = "io.kotest.extensions:kotest-assertions-arrow-jvm", version.ref = "kotestArrow" }
 kotestJunitRunnerJvm = { module = "io.kotest:kotest-runner-junit5-jvm", version.ref = "kotest" }
 kotestProperty = { module = "io.kotest:kotest-property", version.ref = "kotest" }
 kotlinLogging = { module = "io.github.oshai:kotlin-logging", version.ref = "kotlinLogging" }
 kotlinReflect = { module = "org.jetbrains.kotlin:kotlin-reflect", version.ref = "kotlin" }
+kotlinxCoroutinesCore = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "kotlinxCoroutines" }
 mavenPublishGradlePlugin = { module = "com.vanniktech:gradle-maven-publish-plugin", version.ref = "mavenPublish" }
 mockk = { module = "io.mockk:mockk", version.ref = "mockk" }
 moshi = { module = "com.squareup.moshi:moshi", version.ref = "moshi" }

innie/build.gradle.kts

@@ -24,10 +24,11 @@ dependencies {
   implementation(libs.arrowCore)
   implementation(libs.bitcoinj)
   implementation(libs.domainApi)
+  implementation(libs.domainApiKfsmv2)
   implementation(libs.guice)
   implementation(libs.guiceAssistedInject)
   implementation(libs.jodaMoney)
-  implementation(libs.kfsm)
+  implementation(libs.kfsmv2)
   implementation(libs.kotlinLogging)
   implementation(libs.kotlinReflect)
   implementation(libs.moshi)
@@ -49,7 +50,7 @@ tasks.register<JavaExec>("generateStateMachineDiagram") {
   description = "Generate state machine diagram in Mermaid format"
 
   classpath = sourceSets.test.get().runtimeClasspath
-  mainClass.set("xyz.block.bittycity.innie.fsm.StateMachineDiagramGeneratorKt")
+  mainClass.set("xyz.block.bittycity.innie.fsm.DepositDiagramGeneratorKt")
 
   val outputFile = project.file("docs/state-machine.md")
   args(outputFile.absolutePath)
@@ -58,7 +59,6 @@ tasks.register<JavaExec>("generateStateMachineDiagram") {
   inputs.files(fileTree("src/main/kotlin/xyz/block/bittycity/innie/fsm") {
     include("**/*.kt")
   })
-  inputs.file("src/test/kotlin/xyz/block/bittycity/innie/fsm/StateMachineDiagramGenerator.kt")
 
   // Declare output for incremental builds
   outputs.file(outputFile)

innie/docs/state-machine.md

@@ -1,31 +1,32 @@
 ```mermaid
 stateDiagram-v2
-    [*] --> WaitingForDepositConfirmedOnChainStatus
-    CheckingDepositRisk --> Settled
-    CheckingDepositRisk --> WaitingForReversal
-    CheckingEligibility --> CheckingDepositRisk
-    CheckingEligibility --> WaitingForReversal
-    CheckingReversalRisk --> WaitingForReversal
-    CheckingReversalRisk --> WaitingForReversalPendingConfirmationStatus
-    CheckingSanctions --> CheckingReversalRisk
-    CheckingSanctions --> CollectingSanctionsInfo
-    CheckingSanctions --> WaitingForReversal
-    CollectingInfo --> CheckingSanctions
-    CollectingInfo --> WaitingForReversal
-    CollectingSanctionsInfo --> Sanctioned
-    CollectingSanctionsInfo --> WaitingForReversal
-    CollectingSanctionsInfo --> WaitingForSanctionsHeldDecision
-    ExpiredPending --> CheckingEligibility
-    ExpiredPending --> Voided
-    WaitingForDepositConfirmedOnChainStatus --> CheckingEligibility
-    WaitingForDepositConfirmedOnChainStatus --> ExpiredPending
-    WaitingForDepositConfirmedOnChainStatus --> Voided
-    WaitingForReversal --> CollectingInfo
-    WaitingForReversalConfirmedOnChainStatus --> ReversalConfirmedComplete
-    WaitingForReversalConfirmedOnChainStatus --> WaitingForReversal
-    WaitingForReversalPendingConfirmationStatus --> WaitingForReversal
-    WaitingForReversalPendingConfirmationStatus --> WaitingForReversalConfirmedOnChainStatus
-    WaitingForSanctionsHeldDecision --> Sanctioned
-    WaitingForSanctionsHeldDecision --> WaitingForReversal
-    WaitingForSanctionsHeldDecision --> WaitingForReversalPendingConfirmationStatus
+[*] --> New
+CheckingDepositEligibility --> CheckingDepositRisk
+CheckingDepositEligibility --> CollectingReversalInfo
+CheckingDepositRisk --> CollectingReversalInfo
+CheckingDepositRisk --> DepositSettled
+CheckingReversalRisk --> CollectingReversalInfo
+CheckingReversalRisk --> WaitingForReversalPendingConfirmationStatus
+CheckingReversalSanctions --> CheckingReversalRisk
+CheckingReversalSanctions --> CollectingReversalInfo
+CheckingReversalSanctions --> CollectingReversalSanctionsInfo
+CollectingReversalInfo --> CheckingReversalSanctions
+CollectingReversalSanctionsInfo --> CollectingReversalInfo
+CollectingReversalSanctionsInfo --> ReversalSanctioned
+CollectingReversalSanctionsInfo --> WaitingForReversalPendingConfirmationStatus
+CollectingReversalSanctionsInfo --> WaitingForReversalSanctionsHeldDecision
+CreatingDepositTransaction --> WaitingForDepositConfirmedOnChainStatus
+DepositExpiredPending --> CheckingDepositEligibility
+DepositExpiredPending --> DepositVoided
+New --> CreatingDepositTransaction
+WaitingForDepositConfirmedOnChainStatus --> CheckingDepositEligibility
+WaitingForDepositConfirmedOnChainStatus --> DepositExpiredPending
+WaitingForDepositConfirmedOnChainStatus --> DepositVoided
+WaitingForReversalConfirmedOnChainStatus --> CollectingReversalInfo
+WaitingForReversalConfirmedOnChainStatus --> ReversalConfirmedComplete
+WaitingForReversalPendingConfirmationStatus --> CollectingReversalInfo
+WaitingForReversalPendingConfirmationStatus --> WaitingForReversalConfirmedOnChainStatus
+WaitingForReversalSanctionsHeldDecision --> CheckingReversalRisk
+WaitingForReversalSanctionsHeldDecision --> CollectingReversalInfo
+WaitingForReversalSanctionsHeldDecision --> ReversalSanctioned
 ```

innie/src/main/kotlin/xyz/block/bittycity/innie/InnieModule.kt

@@ -3,13 +3,11 @@ package xyz.block.bittycity.innie
 import com.google.inject.AbstractModule
 import xyz.block.bittycity.common.models.Bitcoins
 import xyz.block.bittycity.innie.controllers.DomainControllerModule
-import xyz.block.bittycity.innie.fsm.StateMachineModule
 
 open class InnieModule  : AbstractModule() {
 
   override fun configure() {
     installValidationModule()
-    install(StateMachineModule)
     install(DomainControllerModule)
     Bitcoins.currency
   }

innie/src/main/kotlin/xyz/block/bittycity/innie/api/OnChainDepositDomainApi.kt

@@ -5,17 +5,21 @@ import app.cash.quiver.extensions.success
 import arrow.core.getOrElse
 import arrow.core.raise.result
 import jakarta.inject.Inject
+import java.util.UUID
 import org.bitcoinj.base.Address
 import org.joda.money.CurrencyUnit
+import xyz.block.bittycity.common.client.BitcoinAccountClient
 import xyz.block.bittycity.common.client.ExchangeRateClient
+import xyz.block.bittycity.common.models.BalanceId
 import xyz.block.bittycity.common.models.Bitcoins
+import xyz.block.bittycity.common.models.CustomerId
 import xyz.block.bittycity.common.store.Transactor
 import xyz.block.bittycity.innie.client.WalletClient
 import xyz.block.bittycity.innie.controllers.DomainController
 import xyz.block.bittycity.innie.controllers.IdempotencyHandler
 import xyz.block.bittycity.innie.models.Deposit
 import xyz.block.bittycity.innie.models.DepositState
-import xyz.block.bittycity.innie.models.CheckingEligibility
+import xyz.block.bittycity.innie.models.CheckingDepositEligibility
 import xyz.block.bittycity.innie.models.DepositToken
 import xyz.block.bittycity.innie.models.RequirementId
 import xyz.block.bittycity.innie.models.WaitingForDepositConfirmedOnChainStatus
@@ -28,15 +32,15 @@ import xyz.block.domainapi.ProcessInfo
 import xyz.block.domainapi.SearchParameter
 import xyz.block.domainapi.SearchResult
 import xyz.block.domainapi.UpdateResponse
-import xyz.block.domainapi.util.Operation
-import java.util.UUID
+import xyz.block.domainapi.kfsm.v2.util.Operation
 
 typealias DepositDomainController =
   DomainController<DepositToken, DepositState, Deposit, RequirementId>
 
 class OnChainDepositDomainApi @Inject constructor(
   private val transactor: Transactor<DepositOperations>,
   private val domainController: DepositDomainController,
+  private val bitcoinAccountClient: BitcoinAccountClient,
   private val exchangeRateClient: ExchangeRateClient,
   private val walletClient: WalletClient,
   private val idempotencyHandler: IdempotencyHandler
@@ -64,7 +68,8 @@ class OnChainDepositDomainApi @Inject constructor(
           targetWalletAddress = initialRequest.targetWalletAddress,
           blockchainTransactionId = initialRequest.blockchainTransactionId,
           blockchainTransactionOutputIndex = initialRequest.blockchainTransactionOutputIndex,
-          paymentToken = initialRequest.paymentToken
+          paymentToken = initialRequest.paymentToken,
+          targetBalanceToken = getSourceBalanceToken(customerId).bind()
         )
       )
     }.bind()
@@ -151,10 +156,19 @@ class OnChainDepositDomainApi @Inject constructor(
     limit: Int
   ): Result<SearchResult<Unit, Deposit>> = UnsupportedOperationException().failure()
 
+  private fun getSourceBalanceToken(
+    customerId: CustomerId
+  ): Result<BalanceId> = result {
+    val customerSourceBalanceTokens = bitcoinAccountClient.getBitcoinAccounts(customerId).bind()
+    customerSourceBalanceTokens.firstOrNull()?.balanceId ?: raise(
+      IllegalStateException("No default balance token found")
+    )
+  }
+
   companion object {
     fun mapPaymentState(state: PaymentState): DepositState = when (state) {
       PaymentState.AWAITING_CONFIRMATION -> WaitingForDepositConfirmedOnChainStatus
-      PaymentState.COMPLETED_CONFIRMED -> CheckingEligibility
+      PaymentState.COMPLETED_CONFIRMED -> CheckingDepositEligibility
     }
   }
 }

innie/src/main/kotlin/xyz/block/bittycity/innie/client/DepositLedgerClient.kt

@@ -0,0 +1,98 @@
+package xyz.block.bittycity.innie.client
+
+import org.bitcoinj.base.Address
+import org.joda.money.Money
+import xyz.block.bittycity.common.models.BalanceId
+import xyz.block.bittycity.common.models.Bitcoins
+import xyz.block.bittycity.common.models.CustomerId
+import xyz.block.bittycity.common.models.LedgerTransactionId
+import xyz.block.bittycity.innie.models.DepositReversalToken
+import xyz.block.bittycity.innie.models.DepositToken
+import java.time.Instant
+
+interface DepositLedgerClient {
+  /**
+   * Confirms a ledger transaction after the blockchain confirms a deposit.
+   *
+   * @param customerId The ID of the user receiving the deposit.
+   * @param balanceId The ID representing the user's stored balance.
+   * @param ledgerTransactionId The ID identifying the ledger transaction.
+   * @return a [Result] indicating whether the confirmation was successful.
+   */
+  fun confirmDepositTransaction(
+    customerId: CustomerId,
+    balanceId: BalanceId,
+    ledgerTransactionId: LedgerTransactionId
+  ): Result<Unit>
+
+  /**
+   * Confirms a ledger transaction after the blockchain confirms a deposit reversal.
+   *
+   * @param customerId The ID of the user initiating the reversal.
+   * @param balanceId The ID representing the user's stored balance.
+   * @param ledgerTransactionId The ID identifying the ledger transaction.
+   * @return a [Result] indicating whether the confirmation was successful.
+   */
+  fun confirmReversalTransaction(
+    customerId: CustomerId,
+    balanceId: BalanceId,
+    ledgerTransactionId: LedgerTransactionId
+  ): Result<Unit>
+
+  /**
+   *  Creates a ledger transaction for an on-chain deposit.
+   *
+   *  @param depositId The ID of the deposit.
+   *  @param customerId The ID of the user receiving the deposit.
+   *  @param balanceId The ID representing the user's stored balance.
+   *  @param createdAt The date when the deposit was created.
+   *  @param amount The deposit amount in bitcoin.
+   *  @param fiatEquivalent The equivalent amount in fiat.
+   *  @return a [Result] containing the ledger [LedgerTransactionId] for the transaction if successful.
+   */
+  fun createDepositTransaction(
+    depositId: DepositToken,
+    customerId: CustomerId,
+    balanceId: BalanceId,
+    createdAt: Instant,
+    amount: Bitcoins,
+    fiatEquivalent: Money
+  ): Result<LedgerTransactionId>
+
+  /**
+   * Voids a ledger transaction if the deposit fails on-chain.
+   *
+   * @param customerId The ID of the user receiving the deposit.
+   * @param balanceId The ID representing the user's stored balance.
+   * @param ledgerTransactionId The ID identifying the ledger transaction.
+   * @return a [Result] indicating whether the voiding operation was successful.
+   */
+  fun voidDepositTransaction(
+    customerId: CustomerId,
+    balanceId: BalanceId,
+    ledgerTransactionId: LedgerTransactionId
+  ): Result<Unit>
+
+  /**
+   * Freezes the funds in the reversal. This typically involves debiting the deposit funds that were previously reserved
+   * and crediting them to a sanctions account.
+   *
+   *  @param depositReversalId The ID of the reversal.
+   *  @param customerId The ID of the user receiving the deposit.
+   *  @param balanceId The ID representing the user's stored balance.
+   *  @param createdAt The date when the deposit was created.
+   *  @param amount The deposit amount in bitcoin.
+   *  @param fiatEquivalent The equivalent amount in fiat.
+   *  @param targetWalletAddress The target wallet address of the reversal.
+   *  @return a [Result] indicating whether the funds were frozen successfully.
+   */
+  fun freezeFunds(
+    depositReversalId: DepositReversalToken,
+    customerId: CustomerId,
+    balanceId: BalanceId,
+    createdAt: Instant,
+    amount: Bitcoins,
+    fiatEquivalent: Money,
+    targetWalletAddress: Address
+  ): Result<Unit>
+}