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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
|
/*
This file is part of TALER
(C) 2015 GNUnet e.V.
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.
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
TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/>
*/
/**
* Common types that are used by Taler.
*
* Note most types are defined in wallet.ts, types that
* are defined in types.ts are intended to be used by components
* that do not depend on the whole wallet implementation (which depends on
* emscripten).
*
* @author Florian Dold
*/
import { Checkable } from "./checkable";
@Checkable.Class
export class AmountJson {
@Checkable.Number
value: number;
@Checkable.Number
fraction: number;
@Checkable.String
currency: string;
static checked: (obj: any) => AmountJson;
}
export interface SignedAmountJson {
amount: AmountJson;
isNegative: boolean;
}
export interface ReserveRecord {
reserve_pub: string;
reserve_priv: string,
exchange_base_url: string,
created: number,
last_query: number | null,
/**
* Current amount left in the reserve
*/
current_amount: AmountJson | null,
/**
* Amount requested when the reserve was created.
* When a reserve is re-used (rare!) the current_amount can
* be higher than the requested_amount
*/
requested_amount: AmountJson,
/**
* What's the current amount that sits
* in precoins?
*/
precoin_amount: AmountJson;
confirmed: boolean;
/**
* We got some payback to this reserve. We'll cease to automatically
* withdraw money from it.
*/
hasPayback: boolean;
}
export interface AuditorRecord {
baseUrl: string;
auditorPub: string;
expirationStamp: number;
}
export interface ExchangeForCurrencyRecord {
/**
* Priority for automatic selection when withdrawing.
*/
priority: number;
pinnedPub?: string;
baseUrl: string;
}
export interface CurrencyRecord {
name: string;
fractionalDigits: number;
auditors: AuditorRecord[];
exchanges: ExchangeForCurrencyRecord[];
}
@Checkable.Class
export class CreateReserveResponse {
/**
* Exchange URL where the bank should create the reserve.
* The URL is canonicalized in the response.
*/
@Checkable.String
exchange: string;
@Checkable.String
reservePub: string;
static checked: (obj: any) => CreateReserveResponse;
}
export enum DenominationStatus {
Unverified,
VerifiedGood,
VerifiedBad,
}
export class DenominationRecord {
@Checkable.Value(AmountJson)
value: AmountJson;
@Checkable.String
denomPub: string;
@Checkable.String
denomPubHash: string;
@Checkable.Value(AmountJson)
feeWithdraw: AmountJson;
@Checkable.Value(AmountJson)
feeDeposit: AmountJson;
@Checkable.Value(AmountJson)
feeRefresh: AmountJson;
@Checkable.Value(AmountJson)
feeRefund: AmountJson;
@Checkable.String
stampStart: string;
@Checkable.String
stampExpireWithdraw: string;
@Checkable.String
stampExpireLegal: string;
@Checkable.String
stampExpireDeposit: string;
@Checkable.String
masterSig: string;
/**
* Did we verify the signature on the denomination?
*/
@Checkable.Number
status: DenominationStatus;
/**
* Was this denomination still offered by the exchange the last time
* we checked?
* Only false when the exchange redacts a previously published denomination.
*/
@Checkable.Boolean
isOffered: boolean;
@Checkable.String
exchangeBaseUrl: string;
static checked: (obj: any) => Denomination;
}
/**
* Denomination as found in the /keys response from the exchange.
*/
@Checkable.Class
export class Denomination {
@Checkable.Value(AmountJson)
value: AmountJson;
@Checkable.String
denom_pub: string;
@Checkable.Value(AmountJson)
fee_withdraw: AmountJson;
@Checkable.Value(AmountJson)
fee_deposit: AmountJson;
@Checkable.Value(AmountJson)
fee_refresh: AmountJson;
@Checkable.Value(AmountJson)
fee_refund: AmountJson;
@Checkable.String
stamp_start: string;
@Checkable.String
stamp_expire_withdraw: string;
@Checkable.String
stamp_expire_legal: string;
@Checkable.String
stamp_expire_deposit: string;
@Checkable.String
master_sig: string;
static checked: (obj: any) => Denomination;
}
export interface Auditor {
// official name
name: string;
// Auditor's public key
auditor_pub: string;
// Base URL of the auditor
url: string;
}
export interface ExchangeRecord {
baseUrl: string;
masterPublicKey: string;
auditors: Auditor[];
currency: string;
/**
* Timestamp for last update.
*/
lastUpdateTime: number;
}
export interface WireInfo {
[type: string]: any;
}
export interface ReserveCreationInfo {
exchangeInfo: ExchangeRecord;
wireInfo: WireInfo;
selectedDenoms: DenominationRecord[];
withdrawFee: AmountJson;
overhead: AmountJson;
wireFees: ExchangeWireFeesRecord;
isAudited: boolean;
isTrusted: boolean;
earliestDepositExpiration: number;
}
/**
* A coin that isn't yet signed by an exchange.
*/
export interface PreCoinRecord {
coinPub: string;
coinPriv: string;
reservePub: string;
denomPub: string;
blindingKey: string;
withdrawSig: string;
coinEv: string;
exchangeBaseUrl: string;
coinValue: AmountJson;
}
export interface RefreshPreCoinRecord {
publicKey: string;
privateKey: string;
coinEv: string;
blindingKey: string;
}
export interface PaybackRequest {
denom_pub: string;
/**
* Signature over the coin public key by the denomination.
*/
denom_sig: string;
coin_pub: string;
coin_blind_key_secret: string;
coin_sig: string;
}
@Checkable.Class
export class PaybackConfirmation {
/**
* public key of the reserve that will receive the payback.
*/
@Checkable.String
reserve_pub: string;
/**
* How much will the exchange pay back (needed by wallet in
* case coin was partially spent and wallet got restored from backup)
*/
@Checkable.Value(AmountJson)
amount: AmountJson;
/**
* Time by which the exchange received the /payback request.
*/
@Checkable.String
timestamp: string;
/**
* the EdDSA signature of TALER_PaybackConfirmationPS using a current
* signing key of the exchange affirming the successful
* payback request, and that the exchange promises to transfer the funds
* by the date specified (this allows the exchange delaying the transfer
* a bit to aggregate additional payback requests into a larger one).
*/
@Checkable.String
exchange_sig: string;
/**
* Public EdDSA key of the exchange that was used to generate the signature.
* Should match one of the exchange's signing keys from /keys. It is given
* explicitly as the client might otherwise be confused by clock skew as to
* which signing key was used.
*/
@Checkable.String
exchange_pub: string;
static checked: (obj: any) => PaybackConfirmation;
}
/**
* Ongoing refresh
*/
export interface RefreshSessionRecord {
/**
* Public key that's being melted in this session.
*/
meltCoinPub: string;
/**
* How much of the coin's value is melted away
* with this refresh session?
*/
valueWithFee: AmountJson
/**
* Sum of the value of denominations we want
* to withdraw in this session, without fees.
*/
valueOutput: AmountJson;
/**
* Signature to confirm the melting.
*/
confirmSig: string;
/**
* Denominations of the newly requested coins
*/
newDenoms: string[];
preCoinsForGammas: RefreshPreCoinRecord[][];
/**
* The transfer keys, kappa of them.
*/
transferPubs: string[];
transferPrivs: string[];
/**
* The no-reveal-index after we've done the melting.
*/
norevealIndex?: number;
/**
* Hash of the session.
*/
hash: string;
exchangeBaseUrl: string;
finished: boolean;
}
export interface CoinPaySig {
coin_sig: string;
coin_pub: string;
ub_sig: string;
denom_pub: string;
f: AmountJson;
}
export enum CoinStatus {
Fresh, TransactionPending, Dirty, Refreshed, PaybackPending, PaybackDone,
}
/**
* CoinRecord as stored in the "coins" data store
* of the wallet database.
*/
export interface CoinRecord {
/**
* Public key of the coin.
*/
coinPub: string;
/**
* Private key to authorize operations on the coin.
*/
coinPriv: string;
/**
* Key used by the exchange used to sign the coin.
*/
denomPub: string;
/**
* Unblinded signature by the exchange.
*/
denomSig: string;
/**
* Amount that's left on the coin.
*/
currentAmount: AmountJson;
/**
* Base URL that identifies the exchange from which we got the
* coin.
*/
exchangeBaseUrl: string;
/**
* We have withdrawn the coin, but it's not accepted by the exchange anymore.
* We have to tell an auditor and wait for compensation or for the exchange
* to fix it.
*/
suspended?: boolean;
/**
* Status of the coin.
*/
status: CoinStatus;
}
@Checkable.Class
export class ExchangeHandle {
@Checkable.String
master_pub: string;
@Checkable.String
url: string;
static checked: (obj: any) => ExchangeHandle;
}
export interface WalletBalance {
[currency: string]: WalletBalanceEntry;
}
export interface WalletBalanceEntry {
available: AmountJson;
pendingIncoming: AmountJson;
pendingPayment: AmountJson;
paybackAmount: AmountJson;
}
interface Merchant {
/**
* label for a location with the business address of the merchant
*/
address: string;
/**
* the merchant's legal name of business
*/
name: string;
/**
* label for a location that denotes the jurisdiction for disputes.
* Some of the typical fields for a location (such as a street address) may be absent.
*/
jurisdiction: string;
/**
* Instance of the merchant, in case one merchant
* represents multiple receivers.
*/
instance?: string;
}
@Checkable.ClassWithValidator
export class Contract {
validate() {
if (this.exchanges.length == 0) {
throw Error("no exchanges in contract");
}
}
@Checkable.String
H_wire: string;
@Checkable.String
wire_method: string;
@Checkable.Optional(Checkable.String)
summary?: string;
@Checkable.Optional(Checkable.String)
nonce?: string;
@Checkable.Value(AmountJson)
amount: AmountJson;
@Checkable.List(Checkable.AnyObject)
auditors: any[];
@Checkable.Optional(Checkable.String)
pay_deadline: string;
@Checkable.Any
locations: any;
@Checkable.Value(AmountJson)
max_fee: AmountJson;
@Checkable.Any
merchant: any;
@Checkable.String
merchant_pub: string;
@Checkable.List(Checkable.Value(ExchangeHandle))
exchanges: ExchangeHandle[];
@Checkable.List(Checkable.AnyObject)
products: any[];
@Checkable.String
refund_deadline: string;
@Checkable.String
timestamp: string;
@Checkable.String
order_id: string;
@Checkable.String
pay_url: string;
@Checkable.String
fulfillment_url: string;
@Checkable.Number
wire_fee_amortization?: number;
@Checkable.Value(AmountJson)
max_wire_fee?: AmountJson;
@Checkable.Any
extra: any;
static checked: (obj: any) => Contract;
}
export interface WireFee {
wireFee: AmountJson;
closingFee: AmountJson;
startStamp: number;
endStamp: number;
sig: string;
}
export interface ExchangeWireFeesRecord {
exchangeBaseUrl: string;
feesForType: { [type: string]: WireFee[] };
}
export type PayCoinInfo = Array<{ updatedCoin: CoinRecord, sig: CoinPaySig }>;
export namespace Amounts {
export const fractionalBase = 1e8;
export interface Result {
amount: AmountJson;
// Was there an over-/underflow?
saturated: boolean;
}
export function getMaxAmount(currency: string): AmountJson {
return {
currency,
value: Number.MAX_SAFE_INTEGER,
fraction: 2 ** 32,
}
}
export function getZero(currency: string): AmountJson {
return {
currency,
value: 0,
fraction: 0,
}
}
export function add(first: AmountJson, ...rest: AmountJson[]): Result {
let currency = first.currency;
let value = first.value + Math.floor(first.fraction / fractionalBase);
if (value > Number.MAX_SAFE_INTEGER) {
return { amount: getMaxAmount(currency), saturated: true };
}
let fraction = first.fraction % fractionalBase;
for (let x of rest) {
if (x.currency !== currency) {
throw Error(`Mismatched currency: ${x.currency} and ${currency}`);
}
value = value + x.value + Math.floor((fraction + x.fraction) / fractionalBase);
fraction = (fraction + x.fraction) % fractionalBase;
if (value > Number.MAX_SAFE_INTEGER) {
return { amount: getMaxAmount(currency), saturated: true };
}
}
return { amount: { currency, value, fraction }, saturated: false };
}
export function sub(a: AmountJson, ...rest: AmountJson[]): Result {
let currency = a.currency;
let value = a.value;
let fraction = a.fraction;
for (let b of rest) {
if (b.currency !== currency) {
throw Error(`Mismatched currency: ${b.currency} and ${currency}`);
}
if (fraction < b.fraction) {
if (value < 1) {
return { amount: { currency, value: 0, fraction: 0 }, saturated: true };
}
value--;
fraction += fractionalBase;
}
console.assert(fraction >= b.fraction);
fraction -= b.fraction;
if (value < b.value) {
return { amount: { currency, value: 0, fraction: 0 }, saturated: true };
}
value -= b.value;
}
return { amount: { currency, value, fraction }, saturated: false };
}
export function cmp(a: AmountJson, b: AmountJson): number {
if (a.currency !== b.currency) {
throw Error(`Mismatched currency: ${a.currency} and ${b.currency}`);
}
let av = a.value + Math.floor(a.fraction / fractionalBase);
let af = a.fraction % fractionalBase;
let bv = b.value + Math.floor(b.fraction / fractionalBase);
let bf = b.fraction % fractionalBase;
switch (true) {
case av < bv:
return -1;
case av > bv:
return 1;
case af < bf:
return -1;
case af > bf:
return 1;
case af == bf:
return 0;
default:
throw Error("assertion failed");
}
}
export function copy(a: AmountJson): AmountJson {
return {
value: a.value,
fraction: a.fraction,
currency: a.currency,
}
}
export function divide(a: AmountJson, n: number): AmountJson {
if (n == 0) {
throw Error(`Division by 0`);
}
if (n == 1) {
return {value: a.value, fraction: a.fraction, currency: a.currency};
}
let r = a.value % n;
return {
currency: a.currency,
value: Math.floor(a.value / n),
fraction: Math.floor(((r * fractionalBase) + a.fraction) / n),
}
}
export function isNonZero(a: AmountJson) {
return a.value > 0 || a.fraction > 0;
}
}
export interface Notifier {
notify(): void;
}
/**
* For terseness.
*/
export function mkAmount(value: number, fraction: number, currency: string): AmountJson {
return {value, fraction, currency};
}
|