aboutsummaryrefslogtreecommitdiff
path: root/packages/taler-wallet-core/src/common.ts
blob: d9438d19c175574b84986dae31740ad28573eea9 (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
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
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
/*
 This file is part of GNU Taler
 (C) 2022 GNUnet e.V.

 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/>
 */

/**
 * Imports.
 */
import {
  AbsoluteTime,
  AmountJson,
  Amounts,
  AsyncFlag,
  CoinRefreshRequest,
  CoinStatus,
  Duration,
  ExchangeEntryState,
  ExchangeEntryStatus,
  ExchangeTosStatus,
  ExchangeUpdateStatus,
  Logger,
  ObservabilityEventType,
  RefreshReason,
  TalerError,
  TalerErrorCode,
  TalerErrorDetail,
  TalerPreciseTimestamp,
  TalerProtocolTimestamp,
  TombstoneIdStr,
  Transaction,
  TransactionIdStr,
  WalletNotification,
  assertUnreachable,
  checkDbInvariant,
  checkLogicInvariant,
  durationMul,
} from "@gnu-taler/taler-util";
import {
  BackupProviderRecord,
  CoinHistoryRecord,
  CoinRecord,
  DbPreciseTimestamp,
  DepositGroupRecord,
  ExchangeEntryDbRecordStatus,
  ExchangeEntryDbUpdateStatus,
  ExchangeEntryRecord,
  PeerPullCreditRecord,
  PeerPullPaymentIncomingRecord,
  PeerPushDebitRecord,
  PeerPushPaymentIncomingRecord,
  PurchaseRecord,
  RecoupGroupRecord,
  RefreshGroupRecord,
  WalletDbAllStoresReadOnlyTransaction,
  WalletDbReadWriteTransaction,
  WithdrawalGroupRecord,
  timestampPreciseToDb,
} from "./db.js";
import { ReadyExchangeSummary } from "./exchanges.js";
import { createRefreshGroup } from "./refresh.js";
import { WalletExecutionContext, getDenomInfo } from "./wallet.js";

const logger = new Logger("operations/common.ts");

export interface CoinsSpendInfo {
  coinPubs: string[];
  contributions: AmountJson[];
  refreshReason: RefreshReason;
  /**
   * Transaction for which the coin is spent.
   */
  transactionId: TransactionIdStr;
}

export async function makeCoinsVisible(
  wex: WalletExecutionContext,
  tx: WalletDbReadWriteTransaction<["coins", "coinAvailability"]>,
  transactionId: string,
): Promise<void> {
  const coins =
    await tx.coins.indexes.bySourceTransactionId.getAll(transactionId);
  for (const coinRecord of coins) {
    if (!coinRecord.visible) {
      coinRecord.visible = 1;
      await tx.coins.put(coinRecord);
      const ageRestriction = coinRecord.maxAge;
      const car = await tx.coinAvailability.get([
        coinRecord.exchangeBaseUrl,
        coinRecord.denomPubHash,
        ageRestriction,
      ]);
      if (!car) {
        logger.error("missing coin availability record");
        continue;
      }
      const visCount = car.visibleCoinCount ?? 0;
      car.visibleCoinCount = visCount + 1;
      await tx.coinAvailability.put(car);
    }
  }
}

export async function makeCoinAvailable(
  wex: WalletExecutionContext,
  tx: WalletDbReadWriteTransaction<
    ["coins", "coinAvailability", "denominations"]
  >,
  coinRecord: CoinRecord,
): Promise<void> {
  checkLogicInvariant(coinRecord.status === CoinStatus.Fresh);
  const existingCoin = await tx.coins.get(coinRecord.coinPub);
  if (existingCoin) {
    return;
  }
  const denom = await tx.denominations.get([
    coinRecord.exchangeBaseUrl,
    coinRecord.denomPubHash,
  ]);
  checkDbInvariant(
    !!denom,
    `denomination of a coin is missing hash: ${coinRecord.denomPubHash}`,
  );
  const ageRestriction = coinRecord.maxAge;
  let car = await tx.coinAvailability.get([
    coinRecord.exchangeBaseUrl,
    coinRecord.denomPubHash,
    ageRestriction,
  ]);
  if (!car) {
    car = {
      maxAge: ageRestriction,
      value: denom.value,
      currency: denom.currency,
      denomPubHash: denom.denomPubHash,
      exchangeBaseUrl: denom.exchangeBaseUrl,
      freshCoinCount: 0,
      visibleCoinCount: 0,
    };
  }
  car.freshCoinCount++;
  await tx.coins.put(coinRecord);
  await tx.coinAvailability.put(car);
}

/**
 * Spend coins. Marks the coins as used, adds a coin history items
 * and creates refresh group.
 */
export async function spendCoins(
  wex: WalletExecutionContext,
  tx: WalletDbReadWriteTransaction<
    [
      "coins",
      "coinHistory",
      "coinAvailability",
      "refreshGroups",
      "refreshSessions",
      "denominations",
      "transactionsMeta",
    ]
  >,
  csi: CoinsSpendInfo,
): Promise<void> {
  if (csi.coinPubs.length != csi.contributions.length) {
    throw Error("assertion failed");
  }
  if (csi.coinPubs.length === 0) {
    return;
  }
  let refreshCoinPubs: CoinRefreshRequest[] = [];
  for (let i = 0; i < csi.coinPubs.length; i++) {
    const coin = await tx.coins.get(csi.coinPubs[i]);
    if (!coin) {
      throw Error("coin allocated for payment doesn't exist anymore");
    }
    const denom = await getDenomInfo(
      wex,
      tx,
      coin.exchangeBaseUrl,
      coin.denomPubHash,
    );
    checkDbInvariant(
      !!denom,
      `denomination of a coin is missing hash: ${coin.denomPubHash}`,
    );
    const coinAvailability = await tx.coinAvailability.get([
      coin.exchangeBaseUrl,
      coin.denomPubHash,
      coin.maxAge,
    ]);
    checkDbInvariant(
      !!coinAvailability,
      `age denom info is missing for ${coin.maxAge}`,
    );
    const contrib = csi.contributions[i];
    coin.status = CoinStatus.Dormant;
    const remaining = Amounts.sub(denom.value, contrib);
    if (remaining.saturated) {
      throw Error("not enough remaining balance on coin for payment");
    }
    refreshCoinPubs.push({
      amount: Amounts.stringify(remaining.amount),
      coinPub: coin.coinPub,
    });
    if (coinAvailability.freshCoinCount === 0) {
      throw Error(
        `invalid coin count ${coinAvailability.freshCoinCount} in DB`,
      );
    }
    coinAvailability.freshCoinCount--;
    if (coin.visible) {
      if (!coinAvailability.visibleCoinCount) {
        logger.error("coin availability inconsistent");
      } else {
        coinAvailability.visibleCoinCount--;
      }
    }
    let histEntry: CoinHistoryRecord | undefined = await tx.coinHistory.get(
      coin.coinPub,
    );
    if (!histEntry) {
      histEntry = {
        coinPub: coin.coinPub,
        history: [],
      };
    }
    histEntry.history.push({
      type: "spend",
      transactionId: csi.transactionId,
      amount: Amounts.stringify(contrib),
    });
    await tx.coinHistory.put(histEntry);
    await tx.coins.put(coin);
    await tx.coinAvailability.put(coinAvailability);
  }

  await createRefreshGroup(
    wex,
    tx,
    Amounts.currencyOf(csi.contributions[0]),
    refreshCoinPubs,
    csi.refreshReason,
    csi.transactionId,
  );
}

export enum TombstoneTag {
  DeleteWithdrawalGroup = "delete-withdrawal-group",
  DeleteReserve = "delete-reserve",
  DeletePayment = "delete-payment",
  DeleteReward = "delete-reward",
  DeleteRefreshGroup = "delete-refresh-group",
  DeleteDepositGroup = "delete-deposit-group",
  DeleteRefund = "delete-refund",
  DeletePeerPullDebit = "delete-peer-pull-debit",
  DeletePeerPushDebit = "delete-peer-push-debit",
  DeletePeerPullCredit = "delete-peer-pull-credit",
  DeletePeerPushCredit = "delete-peer-push-credit",
}

export function getExchangeTosStatusFromRecord(
  exchange: ExchangeEntryRecord,
): ExchangeTosStatus {
  if (exchange.tosCurrentEtag == null) {
    return ExchangeTosStatus.MissingTos;
  }
  if (!exchange.tosAcceptedEtag) {
    return ExchangeTosStatus.Proposed;
  }
  if (exchange.tosAcceptedEtag == exchange.tosCurrentEtag) {
    return ExchangeTosStatus.Accepted;
  }
  return ExchangeTosStatus.Proposed;
}

export function getExchangeUpdateStatusFromRecord(
  r: ExchangeEntryRecord,
): ExchangeUpdateStatus {
  switch (r.updateStatus) {
    case ExchangeEntryDbUpdateStatus.UnavailableUpdate:
      return ExchangeUpdateStatus.UnavailableUpdate;
    case ExchangeEntryDbUpdateStatus.Initial:
      return ExchangeUpdateStatus.Initial;
    case ExchangeEntryDbUpdateStatus.InitialUpdate:
      return ExchangeUpdateStatus.InitialUpdate;
    case ExchangeEntryDbUpdateStatus.Ready:
      return ExchangeUpdateStatus.Ready;
    case ExchangeEntryDbUpdateStatus.ReadyUpdate:
      return ExchangeUpdateStatus.ReadyUpdate;
    case ExchangeEntryDbUpdateStatus.Suspended:
      return ExchangeUpdateStatus.Suspended;
    case ExchangeEntryDbUpdateStatus.OutdatedUpdate:
      return ExchangeUpdateStatus.OutdatedUpdate;
    default:
      assertUnreachable(r.updateStatus);
  }
}

export function getExchangeEntryStatusFromRecord(
  r: ExchangeEntryRecord,
): ExchangeEntryStatus {
  switch (r.entryStatus) {
    case ExchangeEntryDbRecordStatus.Ephemeral:
      return ExchangeEntryStatus.Ephemeral;
    case ExchangeEntryDbRecordStatus.Preset:
      return ExchangeEntryStatus.Preset;
    case ExchangeEntryDbRecordStatus.Used:
      return ExchangeEntryStatus.Used;
    default:
      assertUnreachable(r.entryStatus);
  }
}

/**
 * Compute the state of an exchange entry from the DB
 * record.
 */
export function getExchangeState(r: ExchangeEntryRecord): ExchangeEntryState {
  return {
    exchangeEntryStatus: getExchangeEntryStatusFromRecord(r),
    exchangeUpdateStatus: getExchangeUpdateStatusFromRecord(r),
    tosStatus: getExchangeTosStatusFromRecord(r),
  };
}

export type ParsedTombstone =
  | {
      tag: TombstoneTag.DeleteWithdrawalGroup;
      withdrawalGroupId: string;
    }
  | { tag: TombstoneTag.DeleteRefund; refundGroupId: string }
  | { tag: TombstoneTag.DeleteReserve; reservePub: string }
  | { tag: TombstoneTag.DeleteRefreshGroup; refreshGroupId: string }
  | { tag: TombstoneTag.DeleteReward; walletTipId: string }
  | { tag: TombstoneTag.DeletePayment; proposalId: string };

export function constructTombstone(p: ParsedTombstone): TombstoneIdStr {
  switch (p.tag) {
    case TombstoneTag.DeleteWithdrawalGroup:
      return `tmb:${p.tag}:${p.withdrawalGroupId}` as TombstoneIdStr;
    case TombstoneTag.DeleteRefund:
      return `tmb:${p.tag}:${p.refundGroupId}` as TombstoneIdStr;
    case TombstoneTag.DeleteReserve:
      return `tmb:${p.tag}:${p.reservePub}` as TombstoneIdStr;
    case TombstoneTag.DeletePayment:
      return `tmb:${p.tag}:${p.proposalId}` as TombstoneIdStr;
    case TombstoneTag.DeleteRefreshGroup:
      return `tmb:${p.tag}:${p.refreshGroupId}` as TombstoneIdStr;
    case TombstoneTag.DeleteReward:
      return `tmb:${p.tag}:${p.walletTipId}` as TombstoneIdStr;
    default:
      assertUnreachable(p);
  }
}

/**
 * Uniform interface for a particular wallet transaction.
 */
export interface TransactionManager {
  get taskId(): TaskIdStr;
  get transactionId(): TransactionIdStr;
  fail(): Promise<void>;
  abort(): Promise<void>;
  suspend(): Promise<void>;
  resume(): Promise<void>;
  process(): Promise<TaskRunResult>;
}

export enum TaskRunResultType {
  Finished = "finished",
  Backoff = "backoff",
  Progress = "progress",
  Error = "error",
  LongpollReturnedPending = "longpoll-returned-pending",
  ScheduleLater = "schedule-later",
  NetworkRequired = "network-required",
}

export type TaskRunResult =
  | TaskRunFinishedResult
  | TaskRunErrorResult
  | TaskRunBackoffResult
  | TaskRunProgressResult
  | TaskRunLongpollReturnedPendingResult
  | TaskRunScheduleLaterResult
  | TaskRunNetworkRequiredResult;

export namespace TaskRunResult {
  /**
   * Task is finished and does not need to be processed again.
   */
  export function finished(): TaskRunResult {
    return {
      type: TaskRunResultType.Finished,
    };
  }
  /**
   * Task is waiting for something, should be invoked
   * again with exponentiall back-off until some other
   * result is returned.
   */
  export function backoff(): TaskRunResult {
    return {
      type: TaskRunResultType.Backoff,
    };
  }
  /**
   * Task made progress and should be processed again.
   */
  export function progress(): TaskRunResult {
    return {
      type: TaskRunResultType.Progress,
    };
  }
  /**
   * Run the task again at a fixed time in the future.
   */
  export function runAgainAt(runAt: AbsoluteTime): TaskRunResult {
    return {
      type: TaskRunResultType.ScheduleLater,
      runAt,
    };
  }
  /**
   * Longpolling returned, but what we're waiting for
   * is still pending on the other side.
   */
  export function longpollReturnedPending(): TaskRunLongpollReturnedPendingResult {
    return {
      type: TaskRunResultType.LongpollReturnedPending,
    };
  }
  /**
   * Network connection is required to complete the task.
   * When network is back, the transaction will be retried.
   */
  export function networkRequired(): TaskRunResult {
    return {
      type: TaskRunResultType.NetworkRequired,
    };
  }
}

export interface TaskRunFinishedResult {
  type: TaskRunResultType.Finished;
}

export interface TaskRunBackoffResult {
  type: TaskRunResultType.Backoff;
}

export interface TaskRunProgressResult {
  type: TaskRunResultType.Progress;
}

export interface TaskRunScheduleLaterResult {
  type: TaskRunResultType.ScheduleLater;
  runAt: AbsoluteTime;
}

export interface TaskRunLongpollReturnedPendingResult {
  type: TaskRunResultType.LongpollReturnedPending;
}

export interface TaskRunNetworkRequiredResult {
  type: TaskRunResultType.NetworkRequired;
}

export interface TaskRunErrorResult {
  type: TaskRunResultType.Error;
  errorDetail: TalerErrorDetail;
}

export interface DbRetryInfo {
  firstTry: DbPreciseTimestamp;
  nextRetry: DbPreciseTimestamp;
  retryCounter: number;
}

export interface RetryPolicy {
  readonly backoffDelta: Duration;
  readonly backoffBase: number;
  readonly maxTimeout: Duration;
}

const defaultRetryPolicy: RetryPolicy = {
  backoffBase: 1.5,
  backoffDelta: Duration.fromSpec({ seconds: 1 }),
  maxTimeout: Duration.fromSpec({ minutes: 2 }),
};

function updateTimeout(
  r: DbRetryInfo,
  p: RetryPolicy = defaultRetryPolicy,
): void {
  const now = AbsoluteTime.now();
  if (now.t_ms === "never") {
    throw Error("assertion failed");
  }
  if (p.backoffDelta.d_ms === "forever") {
    r.nextRetry = timestampPreciseToDb(
      AbsoluteTime.toPreciseTimestamp(AbsoluteTime.never()),
    );
    return;
  }

  const nextIncrement =
    p.backoffDelta.d_ms * Math.pow(p.backoffBase, r.retryCounter);

  const t =
    now.t_ms +
    (p.maxTimeout.d_ms === "forever"
      ? nextIncrement
      : Math.min(p.maxTimeout.d_ms, nextIncrement));
  r.nextRetry = timestampPreciseToDb(TalerPreciseTimestamp.fromMilliseconds(t));
}

export function computeDbBackoff(retryCounter: number): DbPreciseTimestamp {
  const now = AbsoluteTime.now();
  if (now.t_ms === "never") {
    throw Error("assertion failed");
  }
  const p = defaultRetryPolicy;
  if (p.backoffDelta.d_ms === "forever") {
    throw Error("assertion failed");
  }

  const nextIncrement =
    p.backoffDelta.d_ms * Math.pow(p.backoffBase, retryCounter);

  const t =
    now.t_ms +
    (p.maxTimeout.d_ms === "forever"
      ? nextIncrement
      : Math.min(p.maxTimeout.d_ms, nextIncrement));
  return timestampPreciseToDb(TalerPreciseTimestamp.fromMilliseconds(t));
}

export namespace DbRetryInfo {
  export function reset(p: RetryPolicy = defaultRetryPolicy): DbRetryInfo {
    const now = TalerPreciseTimestamp.now();
    const info: DbRetryInfo = {
      firstTry: timestampPreciseToDb(now),
      nextRetry: timestampPreciseToDb(now),
      retryCounter: 0,
    };
    updateTimeout(info, p);
    return info;
  }

  export function increment(
    r: DbRetryInfo | undefined,
    p: RetryPolicy = defaultRetryPolicy,
  ): DbRetryInfo {
    if (!r) {
      return reset(p);
    }
    const r2 = { ...r };
    r2.retryCounter++;
    updateTimeout(r2, p);
    return r2;
  }
}

/**
 * Timestamp after which the wallet would do an auto-refresh.
 */
export function getAutoRefreshExecuteThreshold(d: {
  stampExpireWithdraw: TalerProtocolTimestamp;
  stampExpireDeposit: TalerProtocolTimestamp;
}): AbsoluteTime {
  const expireWithdraw = AbsoluteTime.fromProtocolTimestamp(
    d.stampExpireWithdraw,
  );
  const expireDeposit = AbsoluteTime.fromProtocolTimestamp(
    d.stampExpireDeposit,
  );
  const delta = AbsoluteTime.difference(expireWithdraw, expireDeposit);
  const deltaDiv = durationMul(delta, 0.5);
  return AbsoluteTime.addDuration(expireWithdraw, deltaDiv);
}

/**
 * Type and schema definitions for pending tasks in the wallet.
 *
 * These are only used internally, and are not part of the stable public
 * interface to the wallet.
 */

export enum PendingTaskType {
  ExchangeUpdate = "exchange-update",
  ExchangeWalletKyc = "exchange-wallet-kyc",
  Purchase = "purchase",
  Refresh = "refresh",
  Recoup = "recoup",
  RewardPickup = "reward-pickup",
  Withdraw = "withdraw",
  Deposit = "deposit",
  Backup = "backup",
  PeerPushDebit = "peer-push-debit",
  PeerPullCredit = "peer-pull-credit",
  PeerPushCredit = "peer-push-credit",
  PeerPullDebit = "peer-pull-debit",
}

/**
 * Parsed representation of task identifiers.
 */
export type ParsedTaskIdentifier =
  | {
      tag: PendingTaskType.Withdraw;
      withdrawalGroupId: string;
    }
  | { tag: PendingTaskType.ExchangeUpdate; exchangeBaseUrl: string }
  | { tag: PendingTaskType.ExchangeWalletKyc; exchangeBaseUrl: string }
  | { tag: PendingTaskType.Backup; backupProviderBaseUrl: string }
  | { tag: PendingTaskType.Deposit; depositGroupId: string }
  | { tag: PendingTaskType.PeerPullDebit; peerPullDebitId: string }
  | { tag: PendingTaskType.PeerPullCredit; pursePub: string }
  | { tag: PendingTaskType.PeerPushCredit; peerPushCreditId: string }
  | { tag: PendingTaskType.PeerPushDebit; pursePub: string }
  | { tag: PendingTaskType.Purchase; proposalId: string }
  | { tag: PendingTaskType.Recoup; recoupGroupId: string }
  | { tag: PendingTaskType.RewardPickup; walletRewardId: string }
  | { tag: PendingTaskType.Refresh; refreshGroupId: string };

export function parseTaskIdentifier(x: string): ParsedTaskIdentifier {
  const task = x.split(":");

  if (task.length < 2) {
    throw Error("task id should have al least 2 parts separated by ':'");
  }

  const [type, ...rest] = task;
  switch (type) {
    case PendingTaskType.Backup:
      return { tag: type, backupProviderBaseUrl: decodeURIComponent(rest[0]) };
    case PendingTaskType.Deposit:
      return { tag: type, depositGroupId: rest[0] };
    case PendingTaskType.ExchangeUpdate:
      return { tag: type, exchangeBaseUrl: decodeURIComponent(rest[0]) };
    case PendingTaskType.ExchangeWalletKyc:
      return { tag: type, exchangeBaseUrl: decodeURIComponent(rest[0]) };
    case PendingTaskType.PeerPullCredit:
      return { tag: type, pursePub: rest[0] };
    case PendingTaskType.PeerPullDebit:
      return { tag: type, peerPullDebitId: rest[0] };
    case PendingTaskType.PeerPushCredit:
      return { tag: type, peerPushCreditId: rest[0] };
    case PendingTaskType.PeerPushDebit:
      return { tag: type, pursePub: rest[0] };
    case PendingTaskType.Purchase:
      return { tag: type, proposalId: rest[0] };
    case PendingTaskType.Recoup:
      return { tag: type, recoupGroupId: rest[0] };
    case PendingTaskType.Refresh:
      return { tag: type, refreshGroupId: rest[0] };
    case PendingTaskType.RewardPickup:
      return { tag: type, walletRewardId: rest[0] };
    case PendingTaskType.Withdraw:
      return { tag: type, withdrawalGroupId: rest[0] };
    default:
      throw Error("invalid task identifier");
  }
}

export function constructTaskIdentifier(p: ParsedTaskIdentifier): TaskIdStr {
  switch (p.tag) {
    case PendingTaskType.Backup:
      return `${p.tag}:${p.backupProviderBaseUrl}` as TaskIdStr;
    case PendingTaskType.Deposit:
      return `${p.tag}:${p.depositGroupId}` as TaskIdStr;
    case PendingTaskType.ExchangeUpdate:
      return `${p.tag}:${encodeURIComponent(p.exchangeBaseUrl)}` as TaskIdStr;
    case PendingTaskType.ExchangeWalletKyc:
      return `${p.tag}:${encodeURIComponent(p.exchangeBaseUrl)}` as TaskIdStr;
    case PendingTaskType.PeerPullDebit:
      return `${p.tag}:${p.peerPullDebitId}` as TaskIdStr;
    case PendingTaskType.PeerPushCredit:
      return `${p.tag}:${p.peerPushCreditId}` as TaskIdStr;
    case PendingTaskType.PeerPullCredit:
      return `${p.tag}:${p.pursePub}` as TaskIdStr;
    case PendingTaskType.PeerPushDebit:
      return `${p.tag}:${p.pursePub}` as TaskIdStr;
    case PendingTaskType.Purchase:
      return `${p.tag}:${p.proposalId}` as TaskIdStr;
    case PendingTaskType.Recoup:
      return `${p.tag}:${p.recoupGroupId}` as TaskIdStr;
    case PendingTaskType.Refresh:
      return `${p.tag}:${p.refreshGroupId}` as TaskIdStr;
    case PendingTaskType.RewardPickup:
      return `${p.tag}:${p.walletRewardId}` as TaskIdStr;
    case PendingTaskType.Withdraw:
      return `${p.tag}:${p.withdrawalGroupId}` as TaskIdStr;
    default:
      assertUnreachable(p);
  }
}

export namespace TaskIdentifiers {
  export function forWithdrawal(wg: WithdrawalGroupRecord): TaskIdStr {
    return `${PendingTaskType.Withdraw}:${wg.withdrawalGroupId}` as TaskIdStr;
  }
  export function forExchangeUpdate(exch: ExchangeEntryRecord): TaskIdStr {
    return `${PendingTaskType.ExchangeUpdate}:${encodeURIComponent(
      exch.baseUrl,
    )}` as TaskIdStr;
  }
  export function forExchangeUpdateFromUrl(exchBaseUrl: string): TaskIdStr {
    return `${PendingTaskType.ExchangeUpdate}:${encodeURIComponent(
      exchBaseUrl,
    )}` as TaskIdStr;
  }
  export function forRefresh(
    refreshGroupRecord: RefreshGroupRecord,
  ): TaskIdStr {
    return `${PendingTaskType.Refresh}:${refreshGroupRecord.refreshGroupId}` as TaskIdStr;
  }
  export function forPay(purchaseRecord: PurchaseRecord): TaskIdStr {
    return `${PendingTaskType.Purchase}:${purchaseRecord.proposalId}` as TaskIdStr;
  }
  export function forRecoup(recoupRecord: RecoupGroupRecord): TaskIdStr {
    return `${PendingTaskType.Recoup}:${recoupRecord.recoupGroupId}` as TaskIdStr;
  }
  export function forDeposit(depositRecord: DepositGroupRecord): TaskIdStr {
    return `${PendingTaskType.Deposit}:${depositRecord.depositGroupId}` as TaskIdStr;
  }
  export function forBackup(backupRecord: BackupProviderRecord): TaskIdStr {
    return `${PendingTaskType.Backup}:${encodeURIComponent(
      backupRecord.baseUrl,
    )}` as TaskIdStr;
  }
  export function forPeerPushPaymentInitiation(
    ppi: PeerPushDebitRecord,
  ): TaskIdStr {
    return `${PendingTaskType.PeerPushDebit}:${ppi.pursePub}` as TaskIdStr;
  }
  export function forPeerPullPaymentInitiation(
    ppi: PeerPullCreditRecord,
  ): TaskIdStr {
    return `${PendingTaskType.PeerPullCredit}:${ppi.pursePub}` as TaskIdStr;
  }
  export function forPeerPullPaymentDebit(
    ppi: PeerPullPaymentIncomingRecord,
  ): TaskIdStr {
    return `${PendingTaskType.PeerPullDebit}:${ppi.peerPullDebitId}` as TaskIdStr;
  }
  export function forPeerPushCredit(
    ppi: PeerPushPaymentIncomingRecord,
  ): TaskIdStr {
    return `${PendingTaskType.PeerPushCredit}:${ppi.peerPushCreditId}` as TaskIdStr;
  }
}

/**
 * Result of a transaction transition.
 */
export enum TransitionResultType {
  Transition = 1,
  Stay = 2,
  Delete = 3,
}

export type TransitionResult<R> =
  | { type: TransitionResultType.Stay }
  | { type: TransitionResultType.Transition; rec: R }
  | { type: TransitionResultType.Delete };

export const TransitionResult = {
  stay<T>(): TransitionResult<T> {
    return { type: TransitionResultType.Stay };
  },
  delete<T>(): TransitionResult<T> {
    return { type: TransitionResultType.Delete };
  },
  transition<T>(rec: T): TransitionResult<T> {
    return {
      type: TransitionResultType.Transition,
      rec,
    };
  },
};

/**
 * Transaction context.
 * Uniform interface to all transactions.
 */
export interface TransactionContext {
  get taskId(): TaskIdStr | undefined;
  get transactionId(): TransactionIdStr;
  abortTransaction(reason?: TalerErrorDetail): Promise<void>;
  suspendTransaction(): Promise<void>;
  resumeTransaction(): Promise<void>;
  failTransaction(reason?: TalerErrorDetail): Promise<void>;
  deleteTransaction(): Promise<void>;
  lookupFullTransaction(
    tx: WalletDbAllStoresReadOnlyTransaction,
  ): Promise<Transaction | undefined>;
}

declare const __taskIdStr: unique symbol;
export type TaskIdStr = string & { [__taskIdStr]: true };

/**
 * Wait until the wallet is in a particular state.
 *
 * Two functions must be provided:
 * 1. checkState, which checks if the wallet is in the
 *    desired state.
 * 2. filterNotification, which checks whether a notification
 *    might have lead to a state change.
 */
export async function genericWaitForState(
  wex: WalletExecutionContext,
  args: {
    checkState: () => Promise<boolean>;
    filterNotification: (notif: WalletNotification) => boolean;
  },
): Promise<void> {
  await wex.taskScheduler.ensureRunning();

  // FIXME: Clean up using the new JS "using" / Symbol.dispose syntax.
  const flag = new AsyncFlag();
  // Raise purchaseNotifFlag whenever we get a notification
  // about our refresh.
  const cancelNotif = wex.ws.addNotificationListener((notif) => {
    if (args.filterNotification(notif)) {
      flag.raise();
    }
  });
  const unregisterOnCancelled = wex.cancellationToken.onCancelled((reason) => {
    cancelNotif();
    flag.raise();
  });

  try {
    while (true) {
      if (wex.cancellationToken.isCancelled) {
        throw Error("cancelled");
      }
      if (await args.checkState()) {
        return;
      }
      // Wait for the next transition
      await flag.wait();
      flag.reset();
    }
  } catch (e) {
    unregisterOnCancelled();
    cancelNotif();
    throw e;
  }
}

/**
 * Wait until the wallet is in a particular state.
 *
 * Two functions must be provided:
 * 1. checkState, which checks if the wallet is in the
 *    desired state.
 * 2. filterNotification, which checks whether a notification
 *    might have lead to a state change.
 */
export async function genericWaitForStateVal<T>(
  wex: WalletExecutionContext,
  args: {
    checkState: () => Promise<T | undefined>;
    filterNotification: (notif: WalletNotification) => boolean;
  },
): Promise<T> {
  await wex.taskScheduler.ensureRunning();

  // FIXME: Clean up using the new JS "using" / Symbol.dispose syntax.
  const flag = new AsyncFlag();
  // Raise purchaseNotifFlag whenever we get a notification
  // about our refresh.
  const cancelNotif = wex.ws.addNotificationListener((notif) => {
    if (args.filterNotification(notif)) {
      flag.raise();
    }
  });
  const unregisterOnCancelled = wex.cancellationToken.onCancelled((reason) => {
    cancelNotif();
    flag.raise();
  });

  try {
    while (true) {
      if (wex.cancellationToken.isCancelled) {
        throw Error("cancelled");
      }
      const val = await args.checkState();
      if (val != null) {
        return val;
      }
      // Wait for the next transition
      await flag.wait();
      flag.reset();
    }
  } catch (e) {
    unregisterOnCancelled();
    cancelNotif();
    throw e;
  }
}

export function requireExchangeTosAcceptedOrThrow(
  exchange: ReadyExchangeSummary,
): void {
  switch (exchange.tosStatus) {
    case ExchangeTosStatus.Accepted:
    case ExchangeTosStatus.MissingTos:
      break;
    default:
      throw TalerError.fromDetail(
        TalerErrorCode.WALLET_EXCHANGE_TOS_NOT_ACCEPTED,
        {
          exchangeBaseUrl: exchange.exchangeBaseUrl,
          currentEtag: exchange.tosCurrentEtag,
          tosStatus: exchange.tosStatus,
        },
      );
  }
}

/**
 * Run a request, but cancel the wallet execution context as soon as the client
 * submits another request of the same type.
 */
export async function runWithClientCancellation<R, T>(
  wex: WalletExecutionContext,
  operation: string,
  clientCancellationId: string | undefined,
  handler: () => Promise<T>,
): Promise<T> {
  const clientCancelKey = clientCancellationId
    ? `ccid:${operation}:${clientCancellationId}`
    : undefined;
  const cts = wex.cts;
  if (clientCancelKey && cts) {
    const prevCts = wex.ws.clientCancellationMap.get(clientCancelKey);
    if (prevCts) {
      wex.oc.observe({
        type: ObservabilityEventType.Message,
        contents: `Cancelling previous key ${clientCancelKey}`,
      });
      prevCts.cancel(
        `cancelled by subsequent request with same cancellation ID`,
      );
    } else {
      wex.oc.observe({
        type: ObservabilityEventType.Message,
        contents: `No previous key ${clientCancelKey}`,
      });
    }
    wex.oc.observe({
      type: ObservabilityEventType.Message,
      contents: `Setting clientCancelKey ${clientCancelKey} to ${cts}`,
    });
    wex.ws.clientCancellationMap.set(clientCancelKey, cts);
  }
  try {
    return await handler();
  } finally {
    wex.oc.observe({
      type: ObservabilityEventType.Message,
      contents: `Deleting clientCancelKey ${clientCancelKey} to ${cts}`,
    });
    if (clientCancelKey && wex.cts && !wex.cts.token.isCancelled) {
      wex.ws.clientCancellationMap.delete(clientCancelKey);
    }
  }
}