PeerManager.kt
/*
* This file is part of GNU Taler
* (C) 2022 Taler Systems S.A.
*
* GNU Taler is free software; you can redistribute it and/or modify it under the
* terms of the GNU General Public License as published by the Free Software
* Foundation; either version 3, or (at your option) any later version.
*
* GNU Taler is distributed in the hope that it will be useful, but WITHOUT ANY
* WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
* A PARTICULAR PURPOSE. See the GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along with
* GNU Taler; see the file COPYING. If not, see <http://www.gnu.org/licenses/>
*/
package net.taler.wallet.peer
import android.util.Log
import androidx.annotation.UiThread
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.flow.StateFlow
import kotlinx.coroutines.flow.update
import kotlinx.coroutines.launch
import kotlinx.serialization.Serializable
import kotlinx.serialization.json.Json
import net.taler.common.Amount
import net.taler.common.CurrencySpecification
import net.taler.common.RelativeTime
import net.taler.common.Timestamp
import net.taler.wallet.main.TAG
import net.taler.wallet.backend.BackendManager
import net.taler.wallet.backend.TalerErrorInfo
import net.taler.wallet.backend.WalletBackendApi
import net.taler.wallet.balances.ScopeInfo
import net.taler.wallet.cleanExchange
import net.taler.wallet.exchanges.ExchangeItem
import net.taler.wallet.exchanges.ExchangeManager
import net.taler.wallet.exchanges.ExchangeTosStatus
import net.taler.wallet.payment.InsufficientBalanceHint
import org.json.JSONObject
import java.util.concurrent.TimeUnit.HOURS
import net.taler.wallet.peer.CheckPeerPushDebitResponse.*
const val MAX_LENGTH_SUBJECT = 100
val DEFAULT_EXPIRY = ExpirationOption.DAYS_1
sealed class CheckFeeResult {
abstract val maxDepositAmountEffective: Amount?
abstract val maxDepositAmountRaw: Amount?
data class None(
override val maxDepositAmountEffective: Amount? = null,
override val maxDepositAmountRaw: Amount? = null,
): CheckFeeResult()
data class InsufficientBalance(
val maxAmountEffective: Amount?,
val maxAmountRaw: Amount?,
val causeHint: InsufficientBalanceHint? = null,
override val maxDepositAmountEffective: Amount? = null,
override val maxDepositAmountRaw: Amount? = null,
): CheckFeeResult()
data class Success(
val amountRaw: Amount,
val amountEffective: Amount,
val exchangeBaseUrl: String,
val defaultExpiration: RelativeTime,
override val maxDepositAmountEffective: Amount? = null,
override val maxDepositAmountRaw: Amount? = null,
): CheckFeeResult()
data class Error(
val error: TalerErrorInfo,
override val maxDepositAmountEffective: Amount? = null,
override val maxDepositAmountRaw: Amount? = null,
): CheckFeeResult()
}
@Serializable
data class GetMaxPeerPushDebitAmountResponse(
val effectiveAmount: Amount,
val rawAmount: Amount,
val exchangeBaseUrl: String? = null,
)
class PeerManager(
private val api: WalletBackendApi,
private val exchangeManager: ExchangeManager,
private val scope: CoroutineScope,
) {
private val _outgoingPullState = MutableStateFlow<OutgoingState>(OutgoingIntro)
val pullState: StateFlow<OutgoingState> = _outgoingPullState
private val _outgoingPushState = MutableStateFlow<OutgoingState>(OutgoingIntro)
val pushState: StateFlow<OutgoingState> = _outgoingPushState
private val _incomingPullState = MutableStateFlow<IncomingState>(IncomingChecking)
val incomingPullState: StateFlow<IncomingState> = _incomingPullState
private val _incomingPushState = MutableStateFlow<IncomingState>(IncomingChecking)
val incomingPushState: StateFlow<IncomingState> = _incomingPushState
private suspend fun getSpecForCurrency(currency: String): CurrencySpecification? =
exchangeManager.getCachedSpecForCurrency(currency)
?: exchangeManager.getSpecForScopeInfo(ScopeInfo.Global(currency))
suspend fun checkPeerPullCredit(
amount: Amount,
scopeInfo: ScopeInfo,
loading: Boolean = false,
): CheckPeerPullCreditResult? {
var response: CheckPeerPullCreditResult? = null
val exchangeItem = exchangeManager.findExchange(scopeInfo) ?: return null
if (loading) {
_outgoingPullState.value = OutgoingChecking
}
if (!exchangeItem.tosStatus.isAccepted()) {
_outgoingPullState.value = OutgoingIntro
return CheckPeerPullCreditResult(
tosStatus = exchangeItem.tosStatus,
exchangeBaseUrl = exchangeItem.exchangeBaseUrl,
)
} else if (amount.isZero()) {
_outgoingPullState.value = OutgoingIntro
return CheckPeerPullCreditResult(
tosStatus = exchangeItem.tosStatus,
exchangeBaseUrl = exchangeItem.exchangeBaseUrl,
amountRaw = amount,
amountEffective = amount,
)
}
api.request(
"checkPeerPullCredit",
CheckPeerPullCreditResponse.serializer(),
progressToken = "checkPeerPullCredit",
) {
put("restrictScope", JSONObject(BackendManager.json.encodeToString(scopeInfo)))
put("amount", amount.toJSONString())
}.onSuccess {
response = CheckPeerPullCreditResult(
amountEffective = it.amountEffective,
amountRaw = it.amountRaw,
exchangeBaseUrl = it.exchangeBaseUrl,
tosStatus = exchangeItem.tosStatus,
)
}.onError { error ->
Log.e(TAG, "got checkPeerPullCredit error result $error")
}
if (loading) {
_outgoingPullState.value = OutgoingIntro
}
return response
}
fun initiatePeerPullCredit(amount: Amount, summary: String, expirationHours: Long, exchangeBaseUrl: String) {
_outgoingPullState.value = OutgoingCreating
scope.launch(Dispatchers.IO) {
val expiry = Timestamp.fromMillis(System.currentTimeMillis() + HOURS.toMillis(expirationHours))
api.request("initiatePeerPullCredit", InitiatePeerPullPaymentResponse.serializer()) {
put("exchangeBaseUrl", exchangeBaseUrl)
put("partialContractTerms", JSONObject().apply {
put("amount", amount.toJSONString())
put("summary", summary)
put("purse_expiration", JSONObject(Json.encodeToString(expiry)))
})
}.onSuccess {
_outgoingPullState.value = OutgoingResponse(it.transactionId)
}.onError { error ->
Log.e(TAG, "got initiatePeerPullCredit error result $error")
_outgoingPullState.value = OutgoingError(error)
}
}
}
fun resetPullPayment() {
_outgoingPullState.value = OutgoingIntro
}
suspend fun checkPeerPushFees(
amount: Amount,
exchangeBaseUrl: String? = null,
restrictScope: ScopeInfo? = null,
): CheckFeeResult {
var max: GetMaxPeerPushDebitAmountResponse? = null
var maxError: TalerErrorInfo? = null
getMaxPeerPushDebitAmount(
amount.currency,
exchangeBaseUrl,
restrictScope = restrictScope,
onSuccess = { max = it },
onError = { maxError = it },
)
maxError?.let { return CheckFeeResult.Error(it) }
val maxAmount = max ?: return CheckFeeResult.Error(
TalerErrorInfo.makeCustomError("Could not determine the maximum send amount."),
)
val none = CheckFeeResult.None(
maxDepositAmountEffective = maxAmount.effectiveAmount,
maxDepositAmountRaw = maxAmount.rawAmount,
)
if (amount.isZero()) return none
var response: CheckFeeResult = none
api.request(
"checkPeerPushDebitV2",
CheckPeerPushDebitResponse.serializer(),
progressToken = "checkPeerPushDebitV2",
) {
exchangeBaseUrl?.let { put("exchangeBaseUrl", it) }
restrictScope?.let { put("restrictScope", JSONObject(BackendManager.json.encodeToString(it))) }
put("amount", amount.toJSONString())
}.onSuccess { res ->
response = when (val r = res) {
is CheckPeerPushDebitOkResponse -> CheckFeeResult.Success(
amountRaw = r.amountRaw,
amountEffective = r.amountEffective,
maxDepositAmountEffective = maxAmount.effectiveAmount,
maxDepositAmountRaw = maxAmount.rawAmount,
exchangeBaseUrl = r.exchangeBaseUrl,
defaultExpiration = r.defaultExpiration,
)
is CheckPeerPushDebitInsufficientBalanceResponse -> CheckFeeResult.InsufficientBalance(
maxAmountEffective = r.insufficientBalanceDetails.maxEffectiveSpendAmount,
maxAmountRaw = r.insufficientBalanceDetails.balanceAvailable,
maxDepositAmountEffective = maxAmount.effectiveAmount,
maxDepositAmountRaw = maxAmount.rawAmount,
causeHint = r.insufficientBalanceDetails.causeHint,
)
}
}.onError { error ->
Log.e(TAG, "got checkPeerPushDebit error result $error")
response = CheckFeeResult.Error(error)
}
return response
}
private suspend fun getMaxPeerPushDebitAmount(
currency: String,
exchangeBaseUrl: String? = null,
restrictScope: ScopeInfo? = null,
onSuccess: (GetMaxPeerPushDebitAmountResponse) -> Unit,
onError: (TalerErrorInfo) -> Unit,
) {
api.request(
"getMaxPeerPushDebitAmount",
GetMaxPeerPushDebitAmountResponse.serializer(),
) {
exchangeBaseUrl?.let { put("exchangeBaseUrl", it) }
restrictScope?.let { put("restrictScope", JSONObject(BackendManager.json.encodeToString(it))) }
put("currency", currency)
}.onSuccess {
onSuccess(it)
}.onError { error ->
Log.e(TAG, "got getMaxPeerPushDebitAmount error result $error")
onError(error)
}
}
fun initiatePeerPushDebit(
amount: Amount,
summary: String,
expirationHours: Long,
restrictScope: ScopeInfo? = null,
) {
_outgoingPushState.value = OutgoingCreating
scope.launch(Dispatchers.IO) {
val expiry = Timestamp.fromMillis(System.currentTimeMillis() + HOURS.toMillis(expirationHours))
api.request("initiatePeerPushDebit", InitiatePeerPushDebitResponse.serializer()) {
restrictScope?.let { put("restrictScope", JSONObject(BackendManager.json.encodeToString(it))) }
put("amount", amount.toJSONString())
put("partialContractTerms", JSONObject().apply {
put("amount", amount.toJSONString())
put("summary", summary)
put("purse_expiration", JSONObject(Json.encodeToString(expiry)))
})
}.onSuccess { response ->
_outgoingPushState.value = OutgoingResponse(response.transactionId)
}.onError { error ->
Log.e(TAG, "got initiatePeerPushDebit error result $error")
_outgoingPushState.value = OutgoingError(error)
}
}
}
fun resetPushPayment() {
_outgoingPushState.value = OutgoingIntro
}
fun preparePeerPullDebit(
talerUri: String? = null,
transactionId: String? = null,
) {
_incomingPullState.value = IncomingChecking
scope.launch(Dispatchers.IO) {
api.request(
"preparePeerPullDebit",
PreparePeerPullDebitResponse.serializer(),
progressToken = talerUri ?: transactionId ?: "preparePeerPullDebit",
) {
talerUri?.let { put("talerUri", talerUri) }
transactionId?.let { put("transactionId", transactionId) }
this
}.onSuccess { response ->
val spec = getSpecForCurrency(response.amountRaw.currency)
_incomingPullState.value = IncomingTerms(
amountRaw = response.amountRaw.withSpec(spec),
amountEffective = response.amountEffective.withSpec(spec),
contractTerms = response.contractTerms.copy(
amount = response.contractTerms.amount.withSpec(spec),
),
id = response.transactionId,
)
}.onError { error ->
Log.e(TAG, "got preparePeerPullDebit error result $error")
_incomingPullState.value = IncomingError(error)
}
}
}
fun confirmPeerPullDebit(terms: IncomingTerms) {
_incomingPullState.value = IncomingAccepting(terms)
scope.launch(Dispatchers.IO) {
api.request<Unit>("confirmPeerPullDebit") {
put("transactionId", terms.id)
}.onSuccess {
_incomingPullState.value = IncomingAccepted(terms.id)
}.onError { error ->
Log.e(TAG, "got confirmPeerPullDebit error result $error")
_incomingPullState.value = IncomingError(error)
}
}
}
fun preparePeerPushCredit(
talerUri: String? = null,
transactionId: String? = null,
) {
_incomingPushState.value = IncomingChecking
scope.launch(Dispatchers.IO) a@ {
api.request(
"preparePeerPushCredit",
PreparePeerPushCreditResponse.serializer(),
progressToken = talerUri ?: transactionId ?: "preparePeerPushCredit",
) {
talerUri?.let { put("talerUri", talerUri) }
transactionId?.let { put("transactionId", transactionId) }
this
}.onSuccess { response ->
scope.launch(Dispatchers.IO) b@ {
val exchange = exchangeManager.findExchangeByUrl(response.exchangeBaseUrl)
if (exchange == null) {
Log.d(TAG, "exchange entry for ${response.exchangeBaseUrl} was not found")
_incomingPushState.value = IncomingError(
TalerErrorInfo.makeCustomError( // TODO: localize error
"No provider with URL ${cleanExchange(response.exchangeBaseUrl)} was found in the wallet",
)
)
return@b
}
val spec = exchangeManager.getSpecForScopeInfo(
exchange.scopeInfo ?: ScopeInfo.Exchange(
response.amountRaw.currency,
response.exchangeBaseUrl,
),
)
val amountRaw = response.amountRaw.withSpec(spec)
val amountEffective = response.amountEffective.withSpec(spec)
val contractTerms = response.contractTerms.copy(
amount = response.contractTerms.amount.withSpec(spec),
)
_incomingPushState.value = if (exchange.tosStatus.isAccepted()) {
IncomingTerms(
amountRaw = amountRaw,
amountEffective = amountEffective,
contractTerms = contractTerms,
id = response.transactionId,
)
} else {
IncomingTosReview(
amountRaw = amountRaw,
amountEffective = amountEffective,
contractTerms = contractTerms,
exchangeBaseUrl = response.exchangeBaseUrl,
id = response.transactionId,
)
}
}
}.onError { error ->
Log.e(TAG, "got preparePeerPushCredit error result $error")
_incomingPushState.value = IncomingError(error)
}
}
}
fun confirmPeerPushCredit(terms: IncomingTerms) {
_incomingPushState.value = IncomingAccepting(terms)
scope.launch(Dispatchers.IO) {
api.request<Unit>("confirmPeerPushCredit") {
put("transactionId", terms.id)
}.onSuccess {
_incomingPushState.value = IncomingAccepted(terms.id)
}.onError { error ->
Log.e(TAG, "got confirmPeerPushCredit error result $error")
_incomingPushState.value = IncomingError(error)
}
}
}
@UiThread
fun refreshPeerPushCreditTos(exchanges: List<ExchangeItem>) = scope.launch {
_incomingPushState.update { state ->
var newState = state
if (state is IncomingTosReview) {
exchanges.find { it.exchangeBaseUrl == state.exchangeBaseUrl }?.let { exchange ->
// only an actual acceptance may lift a review we asked for: a list
// fetched before the provider was known still says missing-tos,
// which isAccepted() treats as good enough
if (exchange.tosStatus == ExchangeTosStatus.Accepted) {
newState = IncomingTerms(
amountRaw = state.amountRaw,
amountEffective = state.amountEffective,
contractTerms = state.contractTerms,
id = state.id,
)
}
} ?: run {
Log.d(TAG, "could not refresh ToS status, exchange ${state.exchangeBaseUrl} was not found")
}
}
newState
}
}
}