Add interface for deposit and withdrawal eligibility clients (#111)

* use interface instead of bindings

* Use marker interfaces in respective packages for type safety

Moved DepositEligibilityClient and WithdrawalEligibilityClient marker
interfaces to their respective domain packages (innie.client and outie.client)
rather than keeping them in common.client.

This approach provides:
- Compile-time type safety through distinct marker interfaces
- Clear package ownership and domain separation
- No runtime qualification or annotations needed
- Base EligibilityClient interface defines the contract once

Updated all implementations and test modules to use the correct imports
from their respective domain packages.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>

Author: sarah-uw

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

@@ -10,8 +10,8 @@ import org.bitcoinj.base.Address
 import org.joda.money.CurrencyUnit
 import xyz.block.bittycity.common.client.BitcoinAccountClient
 import xyz.block.bittycity.common.client.Eligibility
-import xyz.block.bittycity.common.client.EligibilityClient
 import xyz.block.bittycity.common.client.ExchangeRateClient
+import xyz.block.bittycity.innie.client.DepositEligibilityClient
 import xyz.block.bittycity.common.client.IneligibleCustomer
 import xyz.block.bittycity.common.models.BalanceId
 import xyz.block.bittycity.common.models.Bitcoins
@@ -44,7 +44,7 @@ class OnChainDepositDomainApi @Inject constructor(
   private val transactor: Transactor<DepositOperations>,
   private val domainController: DepositDomainController,
   private val bitcoinAccountClient: BitcoinAccountClient,
-  private val eligibilityClient: EligibilityClient,
+  private val eligibilityClient: DepositEligibilityClient,
   private val exchangeRateClient: ExchangeRateClient,
   private val walletClient: WalletClient,
   private val idempotencyHandler: IdempotencyHandler

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

@@ -0,0 +1,6 @@
+package xyz.block.bittycity.innie.client
+
+import xyz.block.bittycity.common.client.EligibilityClient
+
+interface DepositEligibilityClient : EligibilityClient
+

innie/src/main/kotlin/xyz/block/bittycity/innie/fsm/DepositEffectHandler.kt

@@ -7,8 +7,8 @@ import io.github.oshai.kotlinlogging.KLogger
 import io.github.oshai.kotlinlogging.KotlinLogging
 import jakarta.inject.Inject
 import xyz.block.bittycity.common.client.Eligibility
-import xyz.block.bittycity.common.client.EligibilityClient
 import xyz.block.bittycity.common.client.Evaluation
+import xyz.block.bittycity.innie.client.DepositEligibilityClient
 import xyz.block.bittycity.common.client.RiskClient
 import xyz.block.bittycity.common.client.RiskEvaluation
 import xyz.block.bittycity.common.client.SanctionsClient
@@ -25,7 +25,7 @@ class DepositEffectHandler @Inject constructor(
   private val ledgerClient: DepositLedgerClient,
   private val depositRiskClient: RiskClient<DepositToken>,
   private val reversalRiskClient: RiskClient<DepositReversalToken>,
-  private val eligibilityClient: EligibilityClient,
+  private val eligibilityClient: DepositEligibilityClient,
   private val sanctionsClient: SanctionsClient<DepositReversalToken>,
 ):
   EffectHandler<DepositToken, Deposit, DepositState, DepositEffect> {

innie/src/test/kotlin/xyz/block/bittycity/innie/testing/FakeEligibilityClient.kt

@@ -1,15 +1,14 @@
 package xyz.block.bittycity.innie.testing
 
-import xyz.block.bittycity.common.testing.TestFake
-
 import app.cash.quiver.extensions.success
 import xyz.block.bittycity.common.client.Eligibility
 import xyz.block.bittycity.common.client.Eligibility.Eligible
-import xyz.block.bittycity.common.client.EligibilityClient
+import xyz.block.bittycity.common.testing.TestFake
+import xyz.block.bittycity.innie.client.DepositEligibilityClient
 
 class FakeEligibilityClient :
   TestFake(),
-  EligibilityClient {
+  DepositEligibilityClient {
 
   var nextEligibilityResult: Result<Eligibility> by resettable { Eligible(emptyList()).success() }
 

innie/src/test/kotlin/xyz/block/bittycity/innie/testing/TestModule.kt

@@ -9,8 +9,8 @@ import com.squareup.moshi.Moshi
 import io.kotest.property.arbitrary.next
 import jakarta.inject.Singleton
 import xyz.block.bittycity.common.client.CurrencyDisplayPreferenceClient
-import xyz.block.bittycity.common.client.EligibilityClient
 import xyz.block.bittycity.common.client.RiskClient
+import xyz.block.bittycity.innie.client.DepositEligibilityClient
 import xyz.block.bittycity.common.client.SanctionsClient
 import xyz.block.bittycity.innie.client.DepositLedgerClient
 import xyz.block.bittycity.innie.models.DepositReversalToken
@@ -55,7 +55,7 @@ class TestModule : AbstractModule() {
     // Bind fake clients
     bindSingletonFake<CurrencyDisplayPreferenceClient, FakeCurrencyDisplayPreferenceClient>()
     bindSingletonFake<MetricsClient, FakeMetricsClient>()
-    bindSingletonFake<EligibilityClient, FakeEligibilityClient>()
+    bindSingletonFake<DepositEligibilityClient, FakeEligibilityClient>()
     bindSingletonFake<DepositLedgerClient, FakeLedgerClient>()
 
     // Bind fake operations

outie/src/main/kotlin/xyz/block/bittycity/outie/api/OnChainWithdrawalDomainApi.kt

@@ -5,32 +5,33 @@ import app.cash.quiver.extensions.success
 import arrow.core.flatMap
 import arrow.core.getOrElse
 import arrow.core.raise.result
+import jakarta.inject.Inject
+import jakarta.inject.Singleton
+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.Eligibility
-import xyz.block.bittycity.common.client.EligibilityClient
 import xyz.block.bittycity.common.client.ExchangeRateClient
 import xyz.block.bittycity.common.client.IneligibleCustomer
-import xyz.block.bittycity.outie.controllers.AdminFailController
-import xyz.block.bittycity.outie.controllers.DomainController
 import xyz.block.bittycity.common.models.BalanceId
 import xyz.block.bittycity.common.models.Bitcoins
-import xyz.block.bittycity.outie.models.CollectingInfo
 import xyz.block.bittycity.common.models.CustomerId
+import xyz.block.bittycity.common.store.Transactor
+import xyz.block.bittycity.outie.client.WithdrawalEligibilityClient
+import xyz.block.bittycity.outie.controllers.AdminFailController
+import xyz.block.bittycity.outie.controllers.DomainController
+import xyz.block.bittycity.outie.controllers.IdempotencyHandler
+import xyz.block.bittycity.outie.models.CollectingInfo
 import xyz.block.bittycity.outie.models.RequirementId
 import xyz.block.bittycity.outie.models.Withdrawal
 import xyz.block.bittycity.outie.models.WithdrawalState
 import xyz.block.bittycity.outie.models.WithdrawalToken
-import xyz.block.bittycity.outie.controllers.IdempotencyHandler
-import xyz.block.bittycity.common.store.Transactor
 import xyz.block.bittycity.outie.store.WithdrawalOperations
 import xyz.block.bittycity.outie.store.WithdrawalStore
 import xyz.block.bittycity.outie.utils.SearchParser
 import xyz.block.bittycity.outie.validation.InvalidSourceBalanceToken
 import xyz.block.bittycity.outie.validation.ValidationService
-import jakarta.inject.Inject
-import jakarta.inject.Singleton
-import org.bitcoinj.base.Address
-import org.joda.money.CurrencyUnit
 import xyz.block.domainapi.DomainApi
 import xyz.block.domainapi.ExecuteResponse
 import xyz.block.domainapi.InfoOnly
@@ -44,7 +45,6 @@ import xyz.block.domainapi.SearchResult
 import xyz.block.domainapi.UpdateResponse
 import xyz.block.domainapi.WarnOnly
 import xyz.block.domainapi.util.Operation
-import java.util.UUID
 
 typealias WithdrawalDomainController =
   DomainController<WithdrawalToken, WithdrawalState, Withdrawal, RequirementId>
@@ -56,7 +56,7 @@ class OnChainWithdrawalDomainApi @Inject constructor(
   private val withdrawalStore: WithdrawalStore,
   private val domainController: WithdrawalDomainController,
   private val bitcoinAccountClient: BitcoinAccountClient,
-  private val eligibilityClient: EligibilityClient,
+  private val eligibilityClient: WithdrawalEligibilityClient,
   private val exchangeRateClient: ExchangeRateClient,
   private val validationService: ValidationService,
   private val idempotencyHandler: IdempotencyHandler,
@@ -307,7 +307,7 @@ data class InitialRequest(
 
 sealed class ApiError :
   Exception(),
-    InfoOnly
+  InfoOnly
 
 data class WithdrawalTokenConflictError(
   val withdrawalToken: WithdrawalToken,

outie/src/main/kotlin/xyz/block/bittycity/outie/client/WithdrawalEligibilityClient.kt

@@ -0,0 +1,5 @@
+package xyz.block.bittycity.outie.client
+
+import xyz.block.bittycity.common.client.EligibilityClient
+
+interface WithdrawalEligibilityClient: EligibilityClient

outie/src/main/kotlin/xyz/block/bittycity/outie/controllers/EligibilityController.kt

@@ -3,8 +3,8 @@ package xyz.block.bittycity.outie.controllers
 import app.cash.kfsm.StateMachine
 import arrow.core.raise.result
 import xyz.block.bittycity.common.client.Eligibility
-import xyz.block.bittycity.common.client.EligibilityClient
 import xyz.block.bittycity.outie.client.MetricsClient
+import xyz.block.bittycity.outie.client.WithdrawalEligibilityClient
 import xyz.block.bittycity.outie.models.CheckingEligibility
 import xyz.block.bittycity.outie.models.FailureReason.CUSTOMER_IS_INELIGIBLE
 import xyz.block.bittycity.outie.models.HoldingSubmission
@@ -21,7 +21,7 @@ import xyz.block.domainapi.util.Operation
 class EligibilityController @Inject constructor(
   stateMachine: StateMachine<WithdrawalToken, Withdrawal, WithdrawalState>,
   withdrawalStore: WithdrawalStore,
-  private val eligibilityClient: EligibilityClient,
+  private val eligibilityClient: WithdrawalEligibilityClient,
   private val metricsClient: MetricsClient,
 ) : WithdrawalController(stateMachine, metricsClient, withdrawalStore) {
 

outie/src/test/kotlin/xyz/block/bittycity/outie/testing/FakeEligibilityClient.kt

@@ -1,15 +1,14 @@
 package xyz.block.bittycity.outie.testing
 
-import xyz.block.bittycity.common.testing.TestFake
-
 import app.cash.quiver.extensions.success
 import xyz.block.bittycity.common.client.Eligibility
 import xyz.block.bittycity.common.client.Eligibility.Eligible
-import xyz.block.bittycity.common.client.EligibilityClient
+import xyz.block.bittycity.common.testing.TestFake
+import xyz.block.bittycity.outie.client.WithdrawalEligibilityClient
 
 class FakeEligibilityClient :
   TestFake(),
-  EligibilityClient {
+  WithdrawalEligibilityClient {
 
   var nextEligibilityResult: Result<Eligibility> by resettable { Eligible(emptyList()).success() }
 

outie/src/test/kotlin/xyz/block/bittycity/outie/testing/TestModule.kt

@@ -7,8 +7,8 @@ import com.google.inject.name.Names
 import xyz.block.bittycity.common.client.PreFlightClient
 import xyz.block.bittycity.common.client.BitcoinAccountClient
 import xyz.block.bittycity.common.client.CurrencyDisplayPreferenceClient
-import xyz.block.bittycity.common.client.EligibilityClient
 import xyz.block.bittycity.outie.client.EventClient
+import xyz.block.bittycity.outie.client.WithdrawalEligibilityClient
 import xyz.block.bittycity.common.client.ExchangeRateClient
 import xyz.block.bittycity.outie.client.FeeQuoteClient
 import xyz.block.bittycity.outie.client.LedgerClient
@@ -60,7 +60,7 @@ class TestModule : AbstractModule() {
       .to(FakeSanctionsClient::class.java)
       .`in`(Scopes.SINGLETON)
     bindSingletonFake<TravelRuleClient, FakeTravelRuleClient>()
-    bindSingletonFake<EligibilityClient, FakeEligibilityClient>()
+    bindSingletonFake<WithdrawalEligibilityClient, FakeEligibilityClient>()
     bind(FakePreFlightClient::class.java).`in`(Scopes.SINGLETON)
     bind(object : com.google.inject.TypeLiteral<PreFlightClient<xyz.block.bittycity.outie.models.Withdrawal>>() {})
       .to(FakePreFlightClient::class.java)