path: root/packages/auditor-backoffice-ui/src/declaration.d.ts

/*
 This file is part of GNU Taler
 (C) 2021-2023 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/>
 */

/**
 *
 * @author Sebastian Javier Marchano (sebasjm)
 * @author Nic Eigel
 */

type HashCode = string;
type EddsaPublicKey = string;
type EddsaSignature = string;
type WireTransferIdentifierRawP = string;
type RelativeTime = TalerProtocolDuration;
type ImageDataUrl = string;
type AuditorUserType = "business" | "individual";


export interface WithId {
    id: string;
}

interface Timestamp {
    // Milliseconds since epoch, or the special
    // value "forever" to represent an event that will
    // never happen.
    t_s: number | "never";
}
interface TalerProtocolDuration {
    d_us: number | "forever";
}
interface Duration {
    d_ms: number | "forever";
}

interface WithId {
    id: string;
}

type Amount = string;
type UUID = string;
type Integer = number;

export namespace AuditorBackend {
    interface DepositConfirmation {
        // identifier
        deposit_confirmation_serial_id: number;

        //TODO Comment
        h_contract_terms: string;

        //TODO Comment
        h_policy: string;

        //TODO Comment
        h_wire: string;

        //TODO Comment
        exchange_timestamp: string;

        //TODO Comment
        refund_deadline: string;

        //TODO Comment
        wire_deadline: string;

        //TODO Comment
        total_without_fee: string;

        //TODO Comment
        coin_pubs: string;

        //TODO Comment
        coin_sigs: string;

        //TODO Comment
        merchant_pub: string;

        //TODO Comment
        merchant_sig: string;

        //TODO Comment
        exchange_pub: string;

        //TODO Comment
        exchange_sig: string;

        //TODO Comment
        suppressed: string;

        //TODO Comment
        ancient: string;
    }

    //TODO rename
    interface Config {
        name: string;
        version: string;
        implementation: string;
        currency: string;
        auditor_public_key: string;
        exchange_master_public_key: string;
    }

    interface ErrorDetail {
        // Numeric error code unique to the condition.
        // The other arguments are specific to the error value reported here.
        code: number;

        // Human-readable description of the error, i.e. "missing parameter", "commitment violation", ...
        // Should give a human-readable hint about the error's nature. Optional, may change without notice!
        hint?: string;

        // Optional detail about the specific input value that failed. May change without notice!
        detail?: string;

        // Name of the parameter that was bogus (if applicable).
        parameter?: string;

        // Path to the argument that was bogus (if applicable).
        path?: string;

        // Offset of the argument that was bogus (if applicable).
        offset?: string;

        // Index of the argument that was bogus (if applicable).
        index?: string;

        // Name of the object that was bogus (if applicable).
        object?: string;

        // Name of the currency than was problematic (if applicable).
        currency?: string;

        // Expected type (if applicable).
        type_expected?: string;

        // Type that was provided instead (if applicable).
        type_actual?: string;
    }

    interface VersionResponse {
        // libtool-style representation of the Merchant protocol version, see
        // https://www.gnu.org/software/libtool/manual/html_node/Versioning.html#Versioning
        // The format is "current:revision:age".
        version: string;

        // Name of the protocol.
        name: "taler-merchant";

        // Default (!) currency supported by this backend.
        // This is the currency that the backend should
        // suggest by default to the user when entering
        // amounts. See currencies for a list of
        // supported currencies and how to render them.
        currency: string;

        // How services should render currencies supported
        // by this backend.  Maps
        // currency codes (e.g. "EUR" or "KUDOS") to
        // the respective currency specification.
        // All currencies in this map are supported by
        // the backend.  Note that the actual currency
        // specifications are a *hint* for applications
        // that would like *advice* on how to render amounts.
        // Applications *may* ignore the currency specification
        // if they know how to render currencies that they are
        // used with.
        currencies: { currency: CurrencySpecification };

        // Array of exchanges trusted by the merchant.
        // Since protocol v6.
        exchanges: ExchangeConfigInfo[];
    }
}

namespace DepositConfirmations {
    interface DepositConfirmationDetail {
        deposit_confirmation_serial_id: number;

        //TODO Comment
        h_contract_terms: string;

        //TODO Comment
        h_policy: string;

        //TODO Comment
        h_wire: string;

        //TODO Comment
        exchange_timestamp: string;

        //TODO Comment
        refund_deadline: string;

        //TODO Comment
        wire_deadline: string;

        //TODO Comment
        total_without_fee: string;

        //TODO Comment
        coin_pubs: string;

        //TODO Comment
        coin_sigs: string;

        //TODO Comment
        merchant_pub: string;

        //TODO Comment
        merchant_sig: string;

        //TODO Comment
        exchange_pub: string;

        //TODO Comment
        exchange_sig: string;

        //TODO Comment
        suppressed: string;

        //TODO Comment
        ancient: string;
    }
}