1 files changed, 352 insertions, 0 deletions
diff --git a/packages/taler-util/src/merchant-api-types.ts b/packages/taler-util/src/merchant-api-types.ts
new file mode 100644
index 000000000..639ae8d13
--- /dev/null
+++ b/packages/taler-util/src/merchant-api-types.ts
@@ -0,0 +1,352 @@
+/*
+ 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/>
+ */
+
+/**
+ * Test harness for various GNU Taler components.
+ * Also provides a fault-injection proxy.
+ *
+ * @author Florian Dold <dold@taler.net>
+ */
+
+/**
+ * Imports.
+ */
+import {
+  AbsoluteTime,
+  AmountString,
+  Codec,
+  CoinPublicKeyString,
+  EddsaPublicKeyString,
+  ExchangeWireAccount,
+  FacadeCredentials,
+  MerchantContractTerms,
+  TalerProtocolDuration,
+  TalerProtocolTimestamp,
+  buildCodecForObject,
+  buildCodecForUnion,
+  codecForAmountString,
+  codecForAny,
+  codecForBoolean,
+  codecForCheckPaymentClaimedResponse,
+  codecForCheckPaymentUnpaidResponse,
+  codecForConstString,
+  codecForExchangeWireAccount,
+  codecForList,
+  codecForMerchantContractTerms,
+  codecForNumber,
+  codecForString,
+  codecForTimestamp,
+  codecOptional,
+} from "@gnu-taler/taler-util";
+
+export interface MerchantPostOrderRequest {
+  // The order must at least contain the minimal
+  // order detail, but can override all
+  order: Partial<MerchantContractTerms>;
+
+  // if set, the backend will then set the refund deadline to the current
+  // time plus the specified delay.
+  refund_delay?: TalerProtocolDuration;
+
+  // specifies the payment target preferred by the client. Can be used
+  // to select among the various (active) wire methods supported by the instance.
+  payment_target?: string;
+
+  // FIXME: some fields are missing
+
+  // Should a token for claiming the order be generated?
+  // False can make sense if the ORDER_ID is sufficiently
+  // high entropy to prevent adversarial claims (like it is
+  // if the backend auto-generates one). Default is 'true'.
+  create_token?: boolean;
+}
+
+export type ClaimToken = string;
+
+export interface MerchantPostOrderResponse {
+  order_id: string;
+  token?: ClaimToken;
+}
+
+export const codecForMerchantPostOrderResponse =
+  (): Codec<MerchantPostOrderResponse> =>
+    buildCodecForObject<MerchantPostOrderResponse>()
+      .property("order_id", codecForString())
+      .property("token", codecOptional(codecForString()))
+      .build("PostOrderResponse");
+
+export const codecForMerchantRefundDetails = (): Codec<RefundDetails> =>
+  buildCodecForObject<RefundDetails>()
+    .property("reason", codecForString())
+    .property("pending", codecForBoolean())
+    .property("amount", codecForAmountString())
+    .property("timestamp", codecForTimestamp)
+    .build("PostOrderResponse");
+
+export const codecForMerchantCheckPaymentPaidResponse =
+  (): Codec<MerchantCheckPaymentPaidResponse> =>
+    buildCodecForObject<MerchantCheckPaymentPaidResponse>()
+      .property("order_status_url", codecForString())
+      .property("order_status", codecForConstString("paid"))
+      .property("refunded", codecForBoolean())
+      .property("wired", codecForBoolean())
+      .property("deposit_total", codecForAmountString())
+      .property("exchange_ec", codecForNumber())
+      .property("exchange_hc", codecForNumber())
+      .property("refund_amount", codecForAmountString())
+      .property("contract_terms", codecForMerchantContractTerms())
+      // FIXME: specify
+      .property("wire_details", codecForAny())
+      .property("wire_reports", codecForAny())
+      .property("refund_details", codecForAny())
+      .build("CheckPaymentPaidResponse");
+
+export type MerchantOrderPrivateStatusResponse =
+  | MerchantCheckPaymentPaidResponse
+  | CheckPaymentUnpaidResponse
+  | CheckPaymentClaimedResponse;
+
+export interface CheckPaymentClaimedResponse {
+  // Wallet claimed the order, but didn't pay yet.
+  order_status: "claimed";
+
+  contract_terms: MerchantContractTerms;
+}
+
+export interface MerchantCheckPaymentPaidResponse {
+  // did the customer pay for this contract
+  order_status: "paid";
+
+  // Was the payment refunded (even partially)
+  refunded: boolean;
+
+  // Did the exchange wire us the funds
+  wired: boolean;
+
+  // Total amount the exchange deposited into our bank account
+  // for this contract, excluding fees.
+  deposit_total: AmountString;
+
+  // Numeric error code indicating errors the exchange
+  // encountered tracking the wire transfer for this purchase (before
+  // we even got to specific coin issues).
+  // 0 if there were no issues.
+  exchange_ec: number;
+
+  // HTTP status code returned by the exchange when we asked for
+  // information to track the wire transfer for this purchase.
+  // 0 if there were no issues.
+  exchange_hc: number;
+
+  // Total amount that was refunded, 0 if refunded is false.
+  refund_amount: AmountString;
+
+  // Contract terms
+  contract_terms: MerchantContractTerms;
+
+  // Ihe wire transfer status from the exchange for this order if available, otherwise empty array
+  wire_details: TransactionWireTransfer[];
+
+  // Reports about trouble obtaining wire transfer details, empty array if no trouble were encountered.
+  wire_reports: TransactionWireReport[];
+
+  // The refund details for this order.  One entry per
+  // refunded coin; empty array if there are no refunds.
+  refund_details: RefundDetails[];
+
+  order_status_url: string;
+}
+
+export interface CheckPaymentUnpaidResponse {
+  order_status: "unpaid";
+
+  // URI that the wallet must process to complete the payment.
+  taler_pay_uri: string;
+
+  order_status_url: string;
+
+  // Alternative order ID which was paid for already in the same session.
+  // Only given if the same product was purchased before in the same session.
+  already_paid_order_id?: string;
+
+  // We do we NOT return the contract terms here because they may not
+  // exist in case the wallet did not yet claim them.
+}
+
+export interface RefundDetails {
+  // Reason given for the refund
+  reason: string;
+
+  // when was the refund approved
+  timestamp: TalerProtocolTimestamp;
+
+  // has not been taken yet
+  pending: boolean;
+
+  // Total amount that was refunded (minus a refund fee).
+  amount: AmountString;
+}
+
+export interface TransactionWireTransfer {
+  // Responsible exchange
+  exchange_url: string;
+
+  // 32-byte wire transfer identifier
+  wtid: string;
+
+  // execution time of the wire transfer
+  execution_time: AbsoluteTime;
+
+  // Total amount that has been wire transferred
+  // to the merchant
+  amount: AmountString;
+
+  // Was this transfer confirmed by the merchant via the
+  // POST /transfers API, or is it merely claimed by the exchange?
+  confirmed: boolean;
+}
+
+export interface TransactionWireReport {
+  // Numerical error code
+  code: number;
+
+  // Human-readable error description
+  hint: string;
+
+  // Numerical error code from the exchange.
+  exchange_ec: number;
+
+  // HTTP status code received from the exchange.
+  exchange_hc: number;
+
+  // Public key of the coin for which we got the exchange error.
+  coin_pub: CoinPublicKeyString;
+}
+
+export interface ReserveStatusEntry {
+  // Public key of the reserve
+  reserve_pub: string;
+
+  // Timestamp when it was established
+  creation_time: AbsoluteTime;
+
+  // Timestamp when it expires
+  expiration_time: AbsoluteTime;
+
+  // Initial amount as per reserve creation call
+  merchant_initial_amount: AmountString;
+
+  // Initial amount as per exchange, 0 if exchange did
+  // not confirm reserve creation yet.
+  exchange_initial_amount: AmountString;
+
+  // Amount picked up so far.
+  pickup_amount: AmountString;
+
+  // Amount approved for tips that exceeds the pickup_amount.
+  committed_amount: AmountString;
+
+  // Is this reserve active (false if it was deleted but not purged)
+  active: boolean;
+}
+
+export interface MerchantInstancesResponse {
+  // List of instances that are present in the backend (see Instance)
+  instances: MerchantInstanceDetail[];
+}
+
+export interface MerchantInstanceDetail {
+  // Merchant name corresponding to this instance.
+  name: string;
+
+  // Merchant instance this response is about ($INSTANCE)
+  id: string;
+
+  // Public key of the merchant/instance, in Crockford Base32 encoding.
+  merchant_pub: EddsaPublicKeyString;
+
+  // List of the payment targets supported by this instance. Clients can
+  // specify the desired payment target in /order requests.  Note that
+  // front-ends do not have to support wallets selecting payment targets.
+  payment_targets: string[];
+}
+
+export interface MerchantTemplateContractDetails {
+  // Human-readable summary for the template.
+  summary?: string;
+
+  // The price is imposed by the merchant and cannot be changed by the customer.
+  // This parameter is optional.
+  amount?: string;
+
+  // Minimum age buyer must have (in years). Default is 0.
+  minimum_age: number;
+
+  // The time the customer need to pay before his order will be deleted.
+  // It is deleted if the customer did not pay and if the duration is over.
+  pay_duration: TalerProtocolDuration;
+}
+
+export interface MerchantTemplateAddDetails {
+  // Template ID to use.
+  template_id: string;
+
+  // Human-readable description for the template.
+  template_description: string;
+
+  // A base64-encoded image selected by the merchant.
+  // This parameter is optional.
+  // We are not sure about it.
+  image?: string;
+
+  // Additional information in a separate template.
+  template_contract: MerchantTemplateContractDetails;
+
+  // OTP device ID.
+  // This parameter is optional.
+  otp_id?: string;
+}
+
+export interface MerchantReserveCreateConfirmation {
+  // Public key identifying the reserve.
+  reserve_pub: EddsaPublicKeyString;
+
+  // Wire accounts of the exchange where to transfer the funds.
+  accounts: ExchangeWireAccount[];
+}
+
+export const codecForMerchantReserveCreateConfirmation =
+  (): Codec<MerchantReserveCreateConfirmation> =>
+    buildCodecForObject<MerchantReserveCreateConfirmation>()
+      .property("accounts", codecForList(codecForExchangeWireAccount()))
+      .property("reserve_pub", codecForString())
+      .build("MerchantReserveCreateConfirmation");
+
+export interface AccountAddDetails {
+  // payto:// URI of the account.
+  payto_uri: string;
+
+  // URL from where the merchant can download information
+  // about incoming wire transfers to this account.
+  credit_facade_url?: string;
+
+  // Credentials to use when accessing the credit facade.
+  // Never returned on a GET (as this may be somewhat
+  // sensitive data). Can be set in POST
+  // or PATCH requests to update (or delete) credentials.
+  // To really delete credentials, set them to the type: "none".
+  credit_facade_credentials?: FacadeCredentials;
+}