summaryrefslogtreecommitdiff
path: root/packages/taler-wallet-core/src/types/backupTypes.ts
blob: 72d0486b16b320ada4aecb226100c0974f4cf9a8 (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
/*
 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/>
 */


/**
 * Type declarations for backup.
 *
 * Contains some redundancy with the other type declarations,
 * as the backup schema must be very stable.
 *
 * @author Florian Dold <dold@taler.net>
 */

type BackupAmountString = string;

/**
 * Content of the backup.
 *
 * The contents of the wallet must be serialized in a deterministic
 * way across implementations, so that the normalized backup content
 * JSON is identical when the wallet's content is identical.
 */
export interface WalletBackupContentV1 {
  schemaId: "gnu-taler-wallet-backup";

  schemaVersion: 1;

  /**
   * Monotonically increasing clock of the wallet,
   * used to determine causality when merging backups.
   */
  clock: number;

  walletRootPub: string;

  /**
   * Per-exchange data sorted by exchange master public key.
   */
  exchanges: BackupExchangeData[];

  reserves: ReserveBackupData[];

  coins: BackupCoin[];

  planchets: BackupWithdrawalPlanchet[];

  refreshSessions: BackupRefreshSession[];
}

export interface BackupRefreshSession {

}


export interface BackupReserve {
  reservePub: string;
  reservePriv: string;
  /**
   * The exchange base URL.
   */
  exchangeBaseUrl: string;

  bankConfirmUrl?: string;

  /**
   * Wire information (as payto URI) for the bank account that
   * transfered funds for this reserve.
   */
  senderWire?: string;
}

export interface ReserveBackupData {
  /**
   * The reserve public key.
   */
  reservePub: string;

  /**
   * The reserve private key.
   */
  reservePriv: string;

  /**
   * The exchange base URL.
   */
  exchangeBaseUrl: string;

  instructedAmount: string;

  /**
   * Wire information (as payto URI) for the bank account that
   * transfered funds for this reserve.
   */
  senderWire?: string;
}

export interface BackupExchangeData {
  exchangeBaseUrl: string;
  exchangeMasterPub: string;

  /**
   * ETag for last terms of service download.
   */
  termsOfServiceAcceptedEtag: string | undefined;
}


export interface BackupWithdrawalPlanchet {
  coinSource: BackupWithdrawCoinSource | BackupTipCoinSource;
  blindingKey: string;
  coinPriv: string;
  coinPub: string;
  denomPubHash: string;

  /**
   * Base URL that identifies the exchange from which we are getting the
   * coin.
   */
  exchangeBaseUrl: string;
}


export enum BackupCoinSourceType {
  Withdraw = "withdraw",
  Refresh = "refresh",
  Tip = "tip",
}

export interface BackupWithdrawCoinSource {
  type: BackupCoinSourceType.Withdraw;
  withdrawalGroupId: string;

  /**
   * Index of the coin in the withdrawal session.
   */
  coinIndex: number;

  /**
   * Reserve public key for the reserve we got this coin from.
   */
  reservePub: string;
}

export interface BackupRefreshCoinSource {
  type: BackupCoinSourceType.Refresh;
  oldCoinPub: string;
}

export interface BackupTipCoinSource {
  type: BackupCoinSourceType.Tip;
  walletTipId: string;
  coinIndex: number;
}

export type BackupCoinSource =
  | BackupWithdrawCoinSource
  | BackupRefreshCoinSource
  | BackupTipCoinSource;

/**
 * Coin that has been withdrawn and might have been
 * (partially) spent.
 */
export interface BackupCoin {
  /**
   * Public key of the coin.
   */
  coinPub: string;

  /**
   * Private key of the coin.
   */
  coinPriv: string;

  /**
   * Where did the coin come from (withdrawal/refresh/tip)?
   * Used for recouping coins.
   */
  coinSource: BackupCoinSource;

  /**
   * Is the coin still fresh
   */
  fresh: boolean;

  /**
   * Blinding key used when withdrawing the coin.
   * Potentionally used again during payback.
   */
  blindingKey: string;

  /**
   * Amount that's left on the coin.
   */
  currentAmount: BackupAmountString;

  /**
   * Base URL that identifies the exchange from which we got the
   * coin.
   */
  exchangeBaseUrl: string;
}