summaryrefslogtreecommitdiff
path: root/wallet/src/main/java/net/taler/wallet/transactions/Transactions.kt
blob: 0817c3668842f7c7ace49f9decf737e683ce68ae (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
/*
 * This file is part of GNU Taler
 * (C) 2020 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.transactions

import android.content.Context
import androidx.annotation.DrawableRes
import androidx.annotation.LayoutRes
import androidx.annotation.StringRes
import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable
import kotlinx.serialization.Transient
import net.taler.common.ContractMerchant
import net.taler.common.ContractProduct
import net.taler.lib.common.Amount
import net.taler.lib.common.Timestamp
import net.taler.wallet.R
import net.taler.wallet.backend.TalerErrorInfo
import net.taler.wallet.cleanExchange
import net.taler.wallet.transactions.WithdrawalDetails.ManualTransfer
import net.taler.wallet.transactions.WithdrawalDetails.TalerBankIntegrationApi

@Serializable
data class Transactions(val transactions: List<Transaction>)

@Serializable
sealed class Transaction {
    abstract val transactionId: String
    abstract val timestamp: Timestamp
    abstract val pending: Boolean
    abstract val error: TalerErrorInfo?
    abstract val amountRaw: Amount
    abstract val amountEffective: Amount

    @get:DrawableRes
    abstract val icon: Int

    @get:LayoutRes
    abstract val detailPageLayout: Int

    abstract val amountType: AmountType

    abstract fun getTitle(context: Context): String

    @get:StringRes
    abstract val generalTitleRes: Int
}

sealed class AmountType {
    object Positive : AmountType()
    object Negative : AmountType()
    object Neutral : AmountType()
}

@Serializable
@SerialName("withdrawal")
class TransactionWithdrawal(
    override val transactionId: String,
    override val timestamp: Timestamp,
    override val pending: Boolean,
    val exchangeBaseUrl: String,
    val withdrawalDetails: WithdrawalDetails,
    override val error: TalerErrorInfo? = null,
    override val amountRaw: Amount,
    override val amountEffective: Amount
) : Transaction() {
    override val icon = R.drawable.transaction_withdrawal
    override val detailPageLayout = R.layout.fragment_transaction_withdrawal

    @Transient
    override val amountType = AmountType.Positive
    override fun getTitle(context: Context) = cleanExchange(exchangeBaseUrl)
    override val generalTitleRes = R.string.withdraw_title
    val confirmed: Boolean
        get() = !pending && (
                (withdrawalDetails is TalerBankIntegrationApi && withdrawalDetails.confirmed) ||
                        withdrawalDetails is ManualTransfer
                )
}

@Serializable
sealed class WithdrawalDetails {
    @Serializable
    @SerialName("manual-transfer")
    class ManualTransfer(
        /**
         * Payto URIs that the exchange supports.
         *
         * Already contains the amount and message.
         */
        val exchangePaytoUris: List<String>
    ) : WithdrawalDetails()

    @Serializable
    @SerialName("taler-bank-integration-api")
    class TalerBankIntegrationApi(
        /**
         * Set to true if the bank has confirmed the withdrawal, false if not.
         * An unconfirmed withdrawal usually requires user-input
         * and should be highlighted in the UI.
         * See also bankConfirmationUrl below.
         */
        val confirmed: Boolean,

        /**
         * If the withdrawal is unconfirmed, this can include a URL for user-initiated confirmation.
         */
        val bankConfirmationUrl: String? = null,
    ) : WithdrawalDetails()
}

@Serializable
@SerialName("payment")
class TransactionPayment(
    override val transactionId: String,
    override val timestamp: Timestamp,
    override val pending: Boolean,
    val info: TransactionInfo,
    val status: PaymentStatus,
    override val error: TalerErrorInfo? = null,
    override val amountRaw: Amount,
    override val amountEffective: Amount
) : Transaction() {
    override val icon = R.drawable.ic_cash_usd_outline
    override val detailPageLayout = R.layout.fragment_transaction_payment

    @Transient
    override val amountType = AmountType.Negative
    override fun getTitle(context: Context) = info.merchant.name
    override val generalTitleRes = R.string.payment_title
}

@Serializable
class TransactionInfo(
    val orderId: String,
    val merchant: ContractMerchant,
    val summary: String,
    @SerialName("summary_i18n")
    val summaryI18n: Map<String, String>? = null,
    val products: List<ContractProduct>,
    val fulfillmentUrl: String? = null,
    /**
     * Message shown to the user after the payment is complete.
     */
    val fulfillmentMessage: String? = null,
    /**
     * Map from IETF BCP 47 language tags to localized fulfillment messages
     */
    val fulfillmentMessage_i18n: Map<String, String>? = null,
)

@Serializable
enum class PaymentStatus {
    @SerialName("aborted")
    Aborted,

    @SerialName("failed")
    Failed,

    @SerialName("paid")
    Paid,

    @SerialName("accepted")
    Accepted
}

@Serializable
@SerialName("refund")
class TransactionRefund(
    override val transactionId: String,
    override val timestamp: Timestamp,
    override val pending: Boolean,
    val refundedTransactionId: String,
    val info: TransactionInfo,
    /**
     * Part of the refund that couldn't be applied because the refund permissions were expired
     */
    val amountInvalid: Amount? = null,
    override val error: TalerErrorInfo? = null,
    override val amountRaw: Amount,
    override val amountEffective: Amount
) : Transaction() {
    override val icon = R.drawable.transaction_refund
    override val detailPageLayout = R.layout.fragment_transaction_payment

    @Transient
    override val amountType = AmountType.Positive
    override fun getTitle(context: Context): String {
        return context.getString(R.string.transaction_refund_from, info.merchant.name)
    }

    override val generalTitleRes = R.string.refund_title
}

@Serializable
@SerialName("tip")
class TransactionTip(
    override val transactionId: String,
    override val timestamp: Timestamp,
    override val pending: Boolean,
    // TODO status: TipStatus,
    val exchangeBaseUrl: String,
    val merchant: ContractMerchant,
    override val error: TalerErrorInfo? = null,
    override val amountRaw: Amount,
    override val amountEffective: Amount
) : Transaction() {
    override val icon = R.drawable.transaction_tip_accepted // TODO different when declined
    override val detailPageLayout = R.layout.fragment_transaction_payment

    @Transient
    override val amountType = AmountType.Positive
    override fun getTitle(context: Context): String {
        return context.getString(R.string.transaction_tip_from, merchant.name)
    }

    override val generalTitleRes = R.string.tip_title
}

@Serializable
@SerialName("refresh")
class TransactionRefresh(
    override val transactionId: String,
    override val timestamp: Timestamp,
    override val pending: Boolean,
    val exchangeBaseUrl: String,
    override val error: TalerErrorInfo? = null,
    override val amountRaw: Amount,
    override val amountEffective: Amount
) : Transaction() {
    override val icon = R.drawable.transaction_refresh
    override val detailPageLayout = R.layout.fragment_transaction_withdrawal

    @Transient
    override val amountType = AmountType.Negative
    override fun getTitle(context: Context): String {
        return context.getString(R.string.transaction_refresh)
    }

    override val generalTitleRes = R.string.transaction_refresh
}