refactor: re-structure type definitions

1 files changed, 0 insertions, 873 deletions

diff --git a/src/walletTypes.ts b/src/walletTypes.ts
deleted file mode 100644
index e136b4e01..000000000
--- a/src/walletTypes.ts
+++ /dev/null
@@ -1,873 +0,0 @@
-/*
- This file is part of TALER
- (C) 2015-2017 GNUnet e.V. and INRIA
-
- 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/>
- */
-
-/**
- * Types used by clients of the wallet.
- *
- * These types are defined in a separate file make tree shaking easier, since
- * some components use these types (via RPC) but do not depend on the wallet
- * code directly.
- */
-
-/**
- * Imports.
- */
-import { Checkable } from "./util/checkable";
-import * as LibtoolVersion from "./util/libtoolVersion";
-
-import { AmountJson } from "./util/amounts";
-
-import {
-  CoinRecord,
-  DenominationRecord,
-  ExchangeRecord,
-  ExchangeWireInfo,
-  WithdrawalSource,
-  RetryInfo,
-} from "./dbTypes";
-import { CoinPaySig, ContractTerms, PayReq } from "./talerTypes";
-
-/**
- * Response for the create reserve request to the wallet.
- */
-@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;
-
-  /**
-   * Reserve public key of the newly created reserve.
-   */
-  @Checkable.String()
-  reservePub: string;
-
-  /**
-   * Verify that a value matches the schema of this class and convert it into a
-   * member.
-   */
-  static checked: (obj: any) => CreateReserveResponse;
-}
-
-/**
- * Information about what will happen when creating a reserve.
- *
- * Sent to the wallet frontend to be rendered and shown to the user.
- */
-export interface ExchangeWithdrawDetails {
-  /**
-   * Exchange that the reserve will be created at.
-   */
-  exchangeInfo: ExchangeRecord;
-
-  /**
-   * Filtered wire info to send to the bank.
-   */
-  exchangeWireAccounts: string[];
-
-  /**
-   * Selected denominations for withdraw.
-   */
-  selectedDenoms: DenominationRecord[];
-
-  /**
-   * Fees for withdraw.
-   */
-  withdrawFee: AmountJson;
-
-  /**
-   * Remaining balance that is too small to be withdrawn.
-   */
-  overhead: AmountJson;
-
-  /**
-   * Wire fees from the exchange.
-   */
-  wireFees: ExchangeWireInfo;
-
-  /**
-   * Does the wallet know about an auditor for
-   * the exchange that the reserve.
-   */
-  isAudited: boolean;
-
-  /**
-   * Did the user already accept the current terms of service for the exchange?
-   */
-  termsOfServiceAccepted: boolean;
-
-  /**
-   * The exchange is trusted directly.
-   */
-  isTrusted: boolean;
-
-  /**
-   * The earliest deposit expiration of the selected coins.
-   */
-  earliestDepositExpiration: Timestamp;
-
-  /**
-   * Number of currently offered denominations.
-   */
-  numOfferedDenoms: number;
-
-  /**
-   * Public keys of trusted auditors for the currency we're withdrawing.
-   */
-  trustedAuditorPubs: string[];
-
-  /**
-   * Result of checking the wallet's version
-   * against the exchange's version.
-   *
-   * Older exchanges don't return version information.
-   */
-  versionMatch: LibtoolVersion.VersionMatchResult | undefined;
-
-  /**
-   * Libtool-style version string for the exchange or "unknown"
-   * for older exchanges.
-   */
-  exchangeVersion: string;
-
-  /**
-   * Libtool-style version string for the wallet.
-   */
-  walletVersion: string;
-}
-
-export interface WithdrawDetails {
-  bankWithdrawDetails: BankWithdrawDetails;
-  exchangeWithdrawDetails: ExchangeWithdrawDetails | undefined;
-}
-
-/**
- * Mapping from currency/exchange to detailed balance
- * information.
- */
-export interface WalletBalance {
-  /**
-   * Mapping from currency name to detailed balance info.
-   */
-  byExchange: { [exchangeBaseUrl: string]: WalletBalanceEntry };
-
-  /**
-   * Mapping from currency name to detailed balance info.
-   */
-  byCurrency: { [currency: string]: WalletBalanceEntry };
-}
-
-/**
- * Detailed wallet balance for a particular currency.
- */
-export interface WalletBalanceEntry {
-  /**
-   * Directly available amount.
-   */
-  available: AmountJson;
-  /**
-   * Amount that we're waiting for (refresh, withdrawal).
-   */
-  pendingIncoming: AmountJson;
-  /**
-   * Amount that's marked for a pending payment.
-   */
-  pendingPayment: AmountJson;
-  /**
-   * Amount that was paid back and we could withdraw again.
-   */
-  paybackAmount: AmountJson;
-
-  pendingIncomingWithdraw: AmountJson;
-  pendingIncomingRefresh: AmountJson;
-  pendingIncomingDirty: AmountJson;
-}
-
-/**
- * Coins used for a payment, with signatures authorizing the payment and the
- * coins with remaining value updated to accomodate for a payment.
- */
-export interface PayCoinInfo {
-  originalCoins: CoinRecord[];
-  updatedCoins: CoinRecord[];
-  sigs: CoinPaySig[];
-}
-
-/**
- * For terseness.
- */
-export function mkAmount(
-  value: number,
-  fraction: number,
-  currency: string,
-): AmountJson {
-  return { value, fraction, currency };
-}
-
-/**
- * Result for confirmPay
- */
-export interface ConfirmPayResult {
-  nextUrl: string;
-}
-
-/**
- * Activity history record.
- */
-export interface HistoryEvent {
-  /**
-   * Type of the history event.
-   */
-  type: string;
-
-  /**
-   * Time when the activity was recorded.
-   */
-  timestamp: Timestamp;
-
-  /**
-   * Details used when rendering the history record.
-   */
-  detail: any;
-
-  /**
-   * Set to 'true' if the event has been explicitly created,
-   * and set to 'false' if the event has been derived from the
-   * state of the database.
-   */
-  explicit: boolean;
-}
-
-/**
- * Information about all sender wire details known to the wallet,
- * as well as exchanges that accept these wire types.
- */
-export interface SenderWireInfos {
-  /**
-   * Mapping from exchange base url to list of accepted
-   * wire types.
-   */
-  exchangeWireTypes: { [exchangeBaseUrl: string]: string[] };
-
-  /**
-   * Sender wire information stored in the wallet.
-   */
-  senderWires: string[];
-}
-
-/**
- * Request to mark a reserve as confirmed.
- */
-@Checkable.Class()
-export class CreateReserveRequest {
-  /**
-   * The initial amount for the reserve.
-   */
-  @Checkable.Value(() => AmountJson)
-  amount: AmountJson;
-
-  /**
-   * Exchange URL where the bank should create the reserve.
-   */
-  @Checkable.String()
-  exchange: string;
-
-  /**
-   * Payto URI that identifies the exchange's account that the funds
-   * for this reserve go into.
-   */
-  @Checkable.String()
-  exchangeWire: string;
-
-  /**
-   * Wire details (as a payto URI) for the bank account that sent the funds to
-   * the exchange.
-   */
-  @Checkable.Optional(Checkable.String())
-  senderWire?: string;
-
-  /**
-   * URL to fetch the withdraw status from the bank.
-   */
-  @Checkable.Optional(Checkable.String())
-  bankWithdrawStatusUrl?: string;
-
-  /**
-   * Verify that a value matches the schema of this class and convert it into a
-   * member.
-   */
-  static checked: (obj: any) => CreateReserveRequest;
-}
-
-/**
- * Request to mark a reserve as confirmed.
- */
-@Checkable.Class()
-export class ConfirmReserveRequest {
-  /**
-   * Public key of then reserve that should be marked
-   * as confirmed.
-   */
-  @Checkable.String()
-  reservePub: string;
-
-  /**
-   * Verify that a value matches the schema of this class and convert it into a
-   * member.
-   */
-  static checked: (obj: any) => ConfirmReserveRequest;
-}
-
-/**
- * Wire coins to the user's own bank account.
- */
-@Checkable.Class()
-export class ReturnCoinsRequest {
-  /**
-   * The amount to wire.
-   */
-  @Checkable.Value(() => AmountJson)
-  amount: AmountJson;
-
-  /**
-   * The exchange to take the coins from.
-   */
-  @Checkable.String()
-  exchange: string;
-
-  /**
-   * Wire details for the bank account of the customer that will
-   * receive the funds.
-   */
-  @Checkable.Any()
-  senderWire?: object;
-
-  /**
-   * Verify that a value matches the schema of this class and convert it into a
-   * member.
-   */
-  static checked: (obj: any) => ReturnCoinsRequest;
-}
-
-/**
- * Result of selecting coins, contains the exchange, and selected
- * coins with their denomination.
- */
-export interface CoinSelectionResult {
-  exchangeUrl: string;
-  cds: CoinWithDenom[];
-  totalFees: AmountJson;
-  /**
-   * Total amount, including wire fees payed by the customer.
-   */
-  totalAmount: AmountJson;
-}
-
-/**
- * Named tuple of coin and denomination.
- */
-export interface CoinWithDenom {
-  /**
-   * A coin.  Must have the same denomination public key as the associated
-   * denomination.
-   */
-  coin: CoinRecord;
-  /**
-   * An associated denomination.
-   */
-  denom: DenominationRecord;
-}
-
-/**
- * Status of processing a tip.
- */
-export interface TipStatus {
-  accepted: boolean;
-  amount: AmountJson;
-  amountLeft: AmountJson;
-  nextUrl: string;
-  exchangeUrl: string;
-  tipId: string;
-  merchantTipId: string;
-  merchantOrigin: string;
-  expirationTimestamp: number;
-  timestamp: number;
-  totalFees: AmountJson;
-}
-
-export interface BenchmarkResult {
-  time: { [s: string]: number };
-  repetitions: number;
-}
-
-/**
- * Cached next URL for a particular session id.
- */
-export interface NextUrlResult {
-  nextUrl: string;
-  lastSessionId: string | undefined;
-}
-
-export type PreparePayResult =
-  | PreparePayResultError
-  | PreparePayResultInsufficientBalance
-  | PreparePayResultPaid
-  | PreparePayResultPaymentPossible;
-
-export interface PreparePayResultPaymentPossible {
-  status: "payment-possible";
-  proposalId: string;
-  contractTerms: ContractTerms;
-  totalFees: AmountJson;
-}
-
-export interface PreparePayResultInsufficientBalance {
-  status: "insufficient-balance";
-  proposalId: string;
-  contractTerms: ContractTerms;
-}
-
-export interface PreparePayResultError {
-  status: "error";
-  error: string;
-}
-
-export interface PreparePayResultPaid {
-  status: "paid";
-  contractTerms: ContractTerms;
-  nextUrl: string;
-}
-
-export interface BankWithdrawDetails {
-  selectionDone: boolean;
-  transferDone: boolean;
-  amount: AmountJson;
-  senderWire?: string;
-  suggestedExchange?: string;
-  confirmTransferUrl?: string;
-  wireTypes: string[];
-  extractedStatusUrl: string;
-}
-
-export interface AcceptWithdrawalResponse {
-  reservePub: string;
-  confirmTransferUrl?: string;
-}
-
-/**
- * Details about a purchase, including refund status.
- */
-export interface PurchaseDetails {
-  contractTerms: ContractTerms;
-  hasRefund: boolean;
-  totalRefundAmount: AmountJson;
-  totalRefundAndRefreshFees: AmountJson;
-}
-
-export interface WalletDiagnostics {
-  walletManifestVersion: string;
-  walletManifestDisplayVersion: string;
-  errors: string[];
-  firefoxIdbProblem: boolean;
-  dbOutdated: boolean;
-}
-
-export interface PendingWithdrawOperation {
-  type: "withdraw";
-  source: WithdrawalSource;
-  withdrawSessionId: string;
-  numCoinsWithdrawn: number;
-  numCoinsTotal: number;
-}
-
-export interface PendingRefreshOperation {
-  type: "refresh";
-}
-
-export interface PendingPayOperation {
-  type: "pay";
-}
-
-export const enum NotificationType {
-  CoinWithdrawn = "coin-withdrawn",
-  ProposalAccepted = "proposal-accepted",
-  ProposalDownloaded = "proposal-downloaded",
-  RefundsSubmitted = "refunds-submitted",
-  PaybackStarted = "payback-started",
-  PaybackFinished = "payback-finished",
-  RefreshRevealed = "refresh-revealed",
-  RefreshMelted = "refresh-melted",
-  RefreshStarted = "refresh-started",
-  RefreshRefused = "refresh-refused",
-  ReserveUpdated = "reserve-updated",
-  ReserveConfirmed = "reserve-confirmed",
-  ReserveDepleted = "reserve-depleted",
-  ReserveCreated = "reserve-created",
-  WithdrawSessionCreated = "withdraw-session-created",
-  WithdrawSessionFinished = "withdraw-session-finished",
-  WaitingForRetry = "waiting-for-retry",
-  RefundStarted = "refund-started",
-  RefundQueried = "refund-queried",
-  RefundFinished = "refund-finished",
-  ExchangeOperationError = "exchange-operation-error",
-  RefreshOperationError = "refresh-operation-error",
-  RefundApplyOperationError = "refund-apply-error",
-  RefundStatusOperationError = "refund-status-error",
-  ProposalOperationError = "proposal-error",
-  TipOperationError = "tip-error",
-  PayOperationError = "pay-error",
-  WithdrawOperationError = "withdraw-error",
-  ReserveOperationError = "reserve-error",
-  Wildcard = "wildcard",
-}
-
-export interface ProposalAcceptedNotification {
-  type: NotificationType.ProposalAccepted;
-  proposalId: string;
-}
-
-export interface CoinWithdrawnNotification {
-  type: NotificationType.CoinWithdrawn;
-}
-
-export interface RefundStartedNotification {
-  type: NotificationType.RefundStarted;
-}
-
-export interface RefundQueriedNotification {
-  type: NotificationType.RefundQueried;
-}
-
-export interface ProposalDownloadedNotification {
-  type: NotificationType.ProposalDownloaded;
-  proposalId: string;
-}
-
-export interface RefundsSubmittedNotification {
-  type: NotificationType.RefundsSubmitted;
-  proposalId: string;
-}
-
-export interface PaybackStartedNotification {
-  type: NotificationType.PaybackStarted;
-}
-
-export interface PaybackFinishedNotification {
-  type: NotificationType.PaybackFinished;
-}
-
-export interface RefreshMeltedNotification {
-  type: NotificationType.RefreshMelted;
-}
-
-export interface RefreshRevealedNotification {
-  type: NotificationType.RefreshRevealed;
-}
-
-export interface RefreshStartedNotification {
-  type: NotificationType.RefreshStarted;
-}
-
-export interface RefreshRefusedNotification {
-  type: NotificationType.RefreshRefused;
-}
-
-export interface ReserveUpdatedNotification {
-  type: NotificationType.ReserveUpdated;
-}
-
-export interface ReserveConfirmedNotification {
-  type: NotificationType.ReserveConfirmed;
-}
-
-export interface WithdrawSessionCreatedNotification {
-  type: NotificationType.WithdrawSessionCreated;
-  withdrawSessionId: string;
-}
-
-export interface WithdrawSessionFinishedNotification {
-  type: NotificationType.WithdrawSessionFinished;
-  withdrawSessionId: string;
-}
-
-export interface ReserveDepletedNotification {
-  type: NotificationType.ReserveDepleted;
-  reservePub: string;
-}
-
-export interface WaitingForRetryNotification {
-  type: NotificationType.WaitingForRetry;
-  numPending: number;
-  numGivingLiveness: number;
-}
-
-export interface RefundFinishedNotification {
-  type: NotificationType.RefundFinished;
-}
-
-export interface ExchangeOperationErrorNotification {
-  type: NotificationType.ExchangeOperationError;
-}
-
-export interface RefreshOperationErrorNotification {
-  type: NotificationType.RefreshOperationError;
-}
-
-export interface RefundStatusOperationErrorNotification {
-  type: NotificationType.RefundStatusOperationError;
-}
-
-export interface RefundApplyOperationErrorNotification {
-  type: NotificationType.RefundApplyOperationError;
-}
-
-export interface PayOperationErrorNotification {
-  type: NotificationType.PayOperationError;
-}
-
-export interface ProposalOperationErrorNotification {
-  type: NotificationType.ProposalOperationError;
-}
-
-export interface TipOperationErrorNotification {
-  type: NotificationType.TipOperationError;
-}
-
-export interface WithdrawOperationErrorNotification {
-  type: NotificationType.WithdrawOperationError;
-}
-
-export interface ReserveOperationErrorNotification {
-  type: NotificationType.ReserveOperationError;
-}
-
-export interface ReserveCreatedNotification {
-  type: NotificationType.ReserveCreated;
-}
-
-export interface WildcardNotification {
-  type: NotificationType.Wildcard;
-}
-
-export type WalletNotification =
-  | WithdrawOperationErrorNotification
-  | ReserveOperationErrorNotification
-  | ExchangeOperationErrorNotification
-  | RefreshOperationErrorNotification
-  | RefundStatusOperationErrorNotification
-  | RefundApplyOperationErrorNotification
-  | ProposalOperationErrorNotification
-  | PayOperationErrorNotification
-  | TipOperationErrorNotification
-  | ProposalAcceptedNotification
-  | ProposalDownloadedNotification
-  | RefundsSubmittedNotification
-  | PaybackStartedNotification
-  | PaybackFinishedNotification
-  | RefreshMeltedNotification
-  | RefreshRevealedNotification
-  | RefreshStartedNotification
-  | RefreshRefusedNotification
-  | ReserveUpdatedNotification
-  | ReserveCreatedNotification
-  | ReserveConfirmedNotification
-  | WithdrawSessionFinishedNotification
-  | ReserveDepletedNotification
-  | WaitingForRetryNotification
-  | RefundStartedNotification
-  | RefundFinishedNotification
-  | RefundQueriedNotification
-  | WithdrawSessionCreatedNotification
-  | CoinWithdrawnNotification
-  | WildcardNotification;
-
-export interface OperationError {
-  type: string;
-  message: string;
-  details: any;
-}
-
-export interface PendingExchangeUpdateOperation {
-  type: "exchange-update";
-  stage: string;
-  reason: string;
-  exchangeBaseUrl: string;
-  lastError: OperationError | undefined;
-}
-
-export interface PendingBugOperation {
-  type: "bug";
-  message: string;
-  details: any;
-}
-
-export interface PendingReserveOperation {
-  type: "reserve";
-  retryInfo: RetryInfo | undefined;
-  stage: string;
-  timestampCreated: Timestamp;
-  reserveType: string;
-  reservePub: string;
-  bankWithdrawConfirmUrl?: string;
-}
-
-export interface PendingRefreshOperation {
-  type: "refresh";
-  lastError?: OperationError;
-  refreshSessionId: string;
-  oldCoinPub: string;
-  refreshStatus: string;
-  refreshOutputSize: number;
-}
-
-export interface PendingDirtyCoinOperation {
-  type: "dirty-coin";
-  coinPub: string;
-}
-
-export interface PendingProposalDownloadOperation {
-  type: "proposal-download";
-  merchantBaseUrl: string;
-  proposalTimestamp: Timestamp;
-  proposalId: string;
-  orderId: string;
-  lastError?: OperationError;
-  retryInfo: RetryInfo;
-}
-
-/**
- * User must choose whether to accept or reject the merchant's
- * proposed contract terms.
- */
-export interface PendingProposalChoiceOperation {
-  type: "proposal-choice";
-  merchantBaseUrl: string;
-  proposalTimestamp: Timestamp;
-  proposalId: string;
-}
-
-export interface PendingTipOperation {
-  type: "tip";
-  tipId: string;
-  merchantBaseUrl: string;
-  merchantTipId: string;
-}
-
-export interface PendingPayOperation {
-  type: "pay";
-  proposalId: string;
-  isReplay: boolean;
-  retryInfo: RetryInfo,
-  lastError: OperationError | undefined;
-}
-
-export interface PendingRefundQueryOperation {
-  type: "refund-query";
-  proposalId: string;
-  retryInfo: RetryInfo,
-  lastError: OperationError | undefined;
-}
-
-export interface PendingRefundApplyOperation {
-  type: "refund-apply";
-  proposalId: string;
-  retryInfo: RetryInfo,
-  lastError: OperationError | undefined;
-  numRefundsPending: number;
-  numRefundsDone: number;
-}
-
-export interface PendingOperationInfoCommon {
-  type: string;
-  givesLifeness: boolean;
-}
-
-export type PendingOperationInfo = PendingOperationInfoCommon &
-  (
-    | PendingWithdrawOperation
-    | PendingReserveOperation
-    | PendingBugOperation
-    | PendingDirtyCoinOperation
-    | PendingExchangeUpdateOperation
-    | PendingRefreshOperation
-    | PendingTipOperation
-    | PendingProposalDownloadOperation
-    | PendingProposalChoiceOperation
-    | PendingPayOperation
-    | PendingRefundQueryOperation
-    | PendingRefundApplyOperation
-  );
-
-export interface PendingOperationsResponse {
-  pendingOperations: PendingOperationInfo[];
-  nextRetryDelay: Duration;
-}
-
-export interface HistoryQuery {
-  /**
-   * Verbosity of history events.
-   * Level 0: Only withdraw, pay, tip and refund events.
-   * Level 1: All events.
-   */
-  level: number;
-}
-
-@Checkable.Class()
-export class Timestamp {
-  /**
-   * Timestamp in milliseconds.
-   */
-  @Checkable.Number()
-  readonly t_ms: number;
-
-  static checked: (obj: any) => Timestamp;
-}
-
-export interface Duration {
-  /**
-   * Duration in milliseconds.
-   */
-  readonly d_ms: number;
-}
-
-export function getTimestampNow(): Timestamp {
-  return {
-    t_ms: new Date().getTime(),
-  };
-}
-
-export interface PlanchetCreationResult {
-  coinPub: string;
-  coinPriv: string;
-  reservePub: string;
-  denomPubHash: string;
-  denomPub: string;
-  blindingKey: string;
-  withdrawSig: string;
-  coinEv: string;
-  coinValue: AmountJson;
-}
-
-export interface PlanchetCreationRequest {
-  value: AmountJson;
-  feeWithdraw: AmountJson;
-  denomPub: string;
-  reservePub: string;
-  reservePriv: string;
-}