blob: 179b6b383b480747296b8a6da17cb3e41cd25ad5 (
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
|
/*
This file is part of GNU Taler
(C) 2019-2023 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/>
*/
/**
* Type and schema definitions for notifications from the wallet to clients
* of the wallet.
*/
/**
* Imports.
*/
import { TransactionState } from "./transactions-types.js";
import { ExchangeEntryState, TalerErrorDetail } from "./wallet-types.js";
export enum NotificationType {
BalanceChange = "balance-change",
BackupOperationError = "backup-error",
PendingOperationProcessed = "pending-operation-processed",
TransactionStateTransition = "transaction-state-transition",
ExchangeStateTransition = "exchange-state-transition",
}
export interface ErrorInfoSummary {
code: number;
hint?: string;
message?: string;
}
export interface TransactionStateTransitionNotification {
type: NotificationType.TransactionStateTransition;
transactionId: string;
oldTxState: TransactionState;
newTxState: TransactionState;
errorInfo?: ErrorInfoSummary;
/**
* Additional "user data" that is dependent on the
* state transition.
*
* Usage should be avoided.
*
* Currently used to notify the iOS app about
* the KYC URL.
*/
experimentalUserData?: any;
}
export interface ExchangeStateTransitionNotification {
type: NotificationType.ExchangeStateTransition;
/**
* Identification of the exchange entry that this
* notification is about.
*/
exchangeBaseUrl: string;
/**
* If missing, the notification means that
* the exchange entry is newly created.
*/
oldExchangeState?: ExchangeEntryState;
newExchangeState: ExchangeEntryState;
errorInfo?: ErrorInfoSummary;
}
export interface BalanceChangeNotification {
type: NotificationType.BalanceChange;
/**
* Transaction ID of the transaction that caused the balance update.
*
* Only used as a hint for debugging, should not be relied upon by clients.
*/
hintTransactionId: string;
}
export interface BackupOperationErrorNotification {
type: NotificationType.BackupOperationError;
error: TalerErrorDetail;
}
export interface PendingOperationProcessedNotification {
type: NotificationType.PendingOperationProcessed;
id: string;
taskResultType: string;
}
export type WalletNotification =
| BalanceChangeNotification
| BackupOperationErrorNotification
| ExchangeStateTransitionNotification
| PendingOperationProcessedNotification
| TransactionStateTransitionNotification;
|
