aboutsummaryrefslogtreecommitdiff
path: root/packages/auditor-backoffice-ui/src/declaration.d.ts
blob: 69839ef054cc11939c3e084a0231e67a3cc11493 (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
/*
 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
 */

export interface WithId {
  id: string;
}

export namespace AuditorBackend {
  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".
    // Name of the protocol.

    name: "taler-auditor";
    version: string;

    // 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.
    implementation: string;
    currency: string;
    auditor_public_key: string;
    exchange_master_public_key: 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 AmountArithmeticInconsistency {
    class ClassAmountArithmeticInconsistency {
      data: AmountArithmeticInconsistencyDetail[];
    }

    interface SummaryResponse {
      amount_arithmetic_inconsistency: AmountArithmeticInconsistencyDetail[];
    }

    interface AmountArithmeticInconsistencyDetail {
      row_id: number;
      operation: string;
      exchange_amount: string;
      auditor_amount: string;
      profitable: boolean;
      suppressed: boolean;
    }
  }

  namespace WireFormatInconsistency {
    class ClassWireFormatInconsistency {
      data: WireFormatInconsistencyDetail[];
    }

    interface SummaryResponse {
      responseData: WireFormatInconsistencyDetail[];
    }

    interface WireFormatInconsistencyDetail {
      row_id: number;
      amount: string;
      wire_offset: string;
      diagnostic: string;
      suppressed: boolean;
    }
  }
}