commit eff9584f71041532a1bf1c5254c09a2a89ffdb1e
parent e7e30485f0468a410dd96d991973fff680a9095e
Author: Nullptrderef <nullptrderef@proton.me>
Date: Sun, 26 May 2024 01:37:39 +0200
wtaf was 91083aa's indentation in auditor.rst
Diffstat:
| M | core/api-auditor.rst | | | 642 | +++++++++++++++++++++++-------------------------------------------------------- |
1 file changed, 182 insertions(+), 460 deletions(-)
diff --git a/core/api-auditor.rst b/core/api-auditor.rst
@@ -222,16 +222,14 @@ To do this, a :ts:type:`GenericUpdate` object may be used.
.. ts:def:: GenericUpdate
interface GenericUpdate {
+ // the row_id of a respective table that should be changed
+ row_id: Integer;
- // the row_id of a respective table that should be changed
- row_id : Integer;
-
- // if true, subsequent GET requests will not, by default, receive the row specified in row_id.
- suppressed : boolean;
+ // if true, subsequent GET requests will not, by default, receive the row specified in row_id.
+ suppressed: boolean;
- // unused
- ancient? : boolean;
-
+ // unused
+ ancient?: boolean;
}
@@ -274,19 +272,11 @@ This API is used to obtain a list of fee time inconsistencies
.. ts:def:: FeeTimeInconsistency
interface FeeTimeInconsistency {
-
-
- row_id : Integer;
-
- type : string;
-
- time : Timestamp;
-
- diagnostic : string;
-
- suppressed : boolean;
-
-
+ row_id: Integer;
+ type: string;
+ time: Timestamp;
+ diagnostic: string;
+ suppressed: boolean;
}
.. note::
@@ -294,8 +284,6 @@ This API is used to obtain a list of fee time inconsistencies
This API is still experimental. The API will be further developed as needed.
-
-
This API is used to suppress select elements of fee time inconsistencies
.. http:patch:: /fee-time-inconsistency
@@ -352,27 +340,15 @@ This API is used to obtain a list of emergencies by count
.. ts:def:: EmergencyByCount
interface EmergencyByCount {
-
-
- row_id : Integer;
-
- denompub_h : HashCode;
-
- num_issued : Integer;
-
- num_known : Integer;
-
- risk : Amount;
-
- start : Timestamp;
-
- deposit_end : Timestamp;
-
- value : Amount;
-
- suppressed : boolean;
-
-
+ row_id: Integer;
+ denompub_h: HashCode;
+ num_issued: Integer;
+ num_known: Integer;
+ risk: Amount;
+ start: Timestamp;
+ deposit_end: Timestamp;
+ value: Amount;
+ suppressed: boolean;
}
.. note::
@@ -438,17 +414,10 @@ This API is used to obtain a list of row inconsistencies
.. ts:def:: RowInconsistency
interface RowInconsistency {
-
-
- row_id : Integer;
-
- row_table : string;
-
- diagnostic : string;
-
- suppressed : boolean;
-
-
+ row_id: Integer;
+ row_table: string;
+ diagnostic: string;
+ suppressed: boolean;
}
.. note::
@@ -514,34 +483,20 @@ This API is used to obtain a list of reserve in inconsistencies
.. ts:def:: ReserveInInconsistency
interface ReserveInInconsistency {
-
-
- row_id : Integer;
-
- amount_exchange_expected : Amount;
-
- amount_wired : Amount;
-
- reserve_pub : EddsaPublicKey;
-
- timestamp : Timestamp;
-
- account : string;
-
- diagnostic : string;
-
- suppressed : boolean;
-
-
+ row_id: Integer;
+ amount_exchange_expected: Amount;
+ amount_wired: Amount;
+ reserve_pub: EddsaPublicKey;
+ timestamp: Timestamp;
+ account: string;
+ diagnostic: string;
+ suppressed: boolean;
}
.. note::
This API is still experimental. The API will be further developed as needed.
-
-
-
This API is used to suppress select elements of reserve in inconsistencies
.. http:patch:: /reserve-in-inconsistency
@@ -557,9 +512,6 @@ This API is used to suppress select elements of reserve in inconsistencies
This API is still experimental. The API will be further developed as needed.
-
-
-
.. purse-not-closed-inconsistencies-list:
Purse Not Closed Inconsistencies
@@ -598,19 +550,11 @@ This API is used to obtain a list of purse not closed inconsistencies
.. ts:def:: PurseNotClosedInconsistencies
interface PurseNotClosedInconsistencies {
-
-
- row_id : Integer;
-
- purse_pub : EddsaPublicKey;
-
- amount : Amount;
-
- expiration_date : Timestamp;
-
- suppressed : boolean;
-
-
+ row_id: Integer;
+ purse_pub: EddsaPublicKey;
+ amount: Amount;
+ expiration_date: Timestamp;
+ suppressed: boolean;
}
.. note::
@@ -618,8 +562,6 @@ This API is used to obtain a list of purse not closed inconsistencies
This API is still experimental. The API will be further developed as needed.
-
-
This API is used to suppress select elements of purse not closed inconsistencies
.. http:patch:: /purse-not-closed-inconsistencies
@@ -675,22 +617,13 @@ This API is used to obtain a list of reserve not closed inconsistencies
.. ts:def:: ReserveNotClosedInconsistency
- interface ReserveNotClosedInconsistency {
-
-
- row_id : Integer;
-
- reserve_pub : EddsaPublicKey;
-
- balance : Amount;
-
- expiration_time : Timestamp;
-
- diagnostic : string;
-
- suppressed : boolean;
-
-
+ interface ReserveNotClosedInconsistency {
+ row_id: Integer;
+ reserve_pub: EddsaPublicKey;
+ balance: Amount;
+ expiration_time: Timestamp;
+ diagnostic: string;
+ suppressed: boolean;
}
.. note::
@@ -698,8 +631,6 @@ This API is used to obtain a list of reserve not closed inconsistencies
This API is still experimental. The API will be further developed as needed.
-
-
This API is used to suppress select elements of reserve not closed inconsistencies
.. http:patch:: /reserve-not-closed-inconsistency
@@ -716,8 +647,6 @@ This API is used to suppress select elements of reserve not closed inconsistenci
This API is still experimental. The API will be further developed as needed.
-
-
.. reserve-balance-insufficient-inconsistency-list:
Reserve Balance Insufficient Inconsistencies
@@ -756,19 +685,11 @@ This API is used to obtain a list of reserve balance insufficient inconsistencie
.. ts:def:: ReserveBalanceInsufficientInconsistency
interface ReserveBalanceInsufficientInconsistency {
-
-
- row_id : Integer;
-
- reserve_pub : EddsaPublicKey;
-
- inconsistency_gain : boolean;
-
- inconsistency_amount : Amount;
-
- suppressed : boolean;
-
-
+ row_id: Integer;
+ reserve_pub: EddsaPublicKey;
+ inconsistency_gain: boolean;
+ inconsistency_amount: Amount;
+ suppressed: boolean;
}
.. note::
@@ -836,19 +757,11 @@ This API is used to obtain a list of bad sig losses
.. ts:def:: BadSigLosses
interface BadSigLosses {
-
-
- row_id : Integer;
-
- operation : string;
-
- loss : Amount;
-
- operation_specific_pub : EddsaPublicKey;
-
- suppressed : boolean;
-
-
+ row_id: Integer;
+ operation: string;
+ loss: Amount;
+ operation_specific_pub: EddsaPublicKey;
+ suppressed: boolean;
}
.. note::
@@ -914,23 +827,13 @@ This API is used to obtain a list of coin inconsistencies
.. ts:def:: CoinInconsistency
interface CoinInconsistency {
-
-
- row_id : Integer;
-
- operation : string;
-
- exchange_amount : Amount;
-
- auditor_amount : Amount;
-
- coin_pub : EddsaPublicKey;
-
- profitable : boolean;
-
- suppressed : boolean;
-
-
+ row_id: Integer;
+ operation: string;
+ exchange_amount: Amount;
+ auditor_amount: Amount;
+ coin_pub: EddsaPublicKey;
+ profitable: boolean;
+ suppressed: boolean;
}
.. note::
@@ -997,17 +900,10 @@ This API is used to obtain a list of balances
.. ts:def:: Balances
interface Balances {
-
-
- row_id : Integer;
-
- balance_key : string;
-
- balance_value : Amount;
-
- suppressed : boolean;
-
-
+ row_id: Integer;
+ balance_key: string;
+ balance_value: Amount;
+ suppressed: boolean;
}
.. note::
@@ -1073,21 +969,12 @@ This API is used to obtain a list of denominations without sigs
.. ts:def:: DenominationsWithoutSigs
interface DenominationsWithoutSigs {
-
-
- row_id : Integer;
-
- denompub_h : HashCode;
-
- value : Amount;
-
- start_time : Timestamp;
-
- end_time : Timestamp;
-
- suppressed : boolean;
-
-
+ row_id: Integer;
+ denompub_h: HashCode;
+ value: Amount;
+ start_time: Timestamp;
+ end_time: Timestamp;
+ suppressed: boolean;
}
.. note::
@@ -1153,19 +1040,11 @@ This API is used to obtain a list of misattribution in inconsistencies
.. ts:def:: MisattributionInInconsistency
interface MisattributionInInconsistency {
-
-
- row_id : Integer;
-
- amount : Amount;
-
- bank_row : Integer;
-
- reserve_pub : EddsaPublicKey;
-
- suppressed : boolean;
-
-
+ row_id: Integer;
+ amount: Amount;
+ bank_row: Integer;
+ reserve_pub: EddsaPublicKey;
+ suppressed: boolean;
}
.. note::
@@ -1231,15 +1110,9 @@ This API is used to obtain a list of progress
.. ts:def:: Progress
interface Progress {
-
-
- progress_key : string;
-
- progress_offset : Integer;
-
- suppressed : boolean;
-
-
+ progress_key: string;
+ progress_offset: Integer;
+ suppressed: boolean;
}
.. note::
@@ -1305,33 +1178,18 @@ This API is used to obtain a list of reserves
.. ts:def:: Reserves
interface Reserves {
-
-
- auditor_reserves_rowid : Integer;
-
- reserve_pub : EddsaPublicKey;
-
- reserve_balance : Amount;
-
- reserve_loss : Amount;
-
- withdraw_fee_balance : Amount;
-
- close_fee_balance : Amount;
-
- purse_fee_balance : Amount;
-
- open_fee_balance : Amount;
-
- history_fee_balance : Amount;
-
- expiration_date : Timestamp;
-
- origin_account : string;
-
- suppressed : boolean;
-
-
+ auditor_reserves_rowid: Integer;
+ reserve_pub: EddsaPublicKey;
+ reserve_balance: Amount;
+ reserve_loss: Amount;
+ withdraw_fee_balance: Amount;
+ close_fee_balance: Amount;
+ purse_fee_balance: Amount;
+ open_fee_balance: Amount;
+ history_fee_balance: Amount;
+ expiration_date: Timestamp;
+ origin_account: string;
+ suppressed: boolean;
}
.. note::
@@ -1397,41 +1255,22 @@ This API is used to obtain a list of deposit confirmations
.. ts:def:: DepositConfirmations
interface DepositConfirmations {
-
-
- deposit_confirmation_serial_id : Integer;
-
- h_contract_terms : HashCode;
-
- h_policy : HashCode;
-
- h_wire : HashCode;
-
- exchange_timestamp : Timestamp;
-
- refund_deadline : Timestamp;
-
- wire_deadline : Timestamp;
-
- total_without_fee : Amount;
-
- coin_pubs : EddsaPublicKey;
-
- coin_sigs : EddsaSignature;
-
- merchant_pub : EddsaPublicKey;
-
- exchange_sig : EddsaSignature;
-
- exchange_pub : EddsaPublicKey;
-
- master_sig : EddsaSignature;
-
- suppressed : boolean;
-
- ancient : boolean;
-
-
+ deposit_confirmation_serial_id: Integer;
+ h_contract_terms: HashCode;
+ h_policy: HashCode;
+ h_wire: HashCode;
+ exchange_timestamp: Timestamp;
+ refund_deadline: Timestamp;
+ wire_deadline: Timestamp;
+ total_without_fee: Amount;
+ coin_pubs: EddsaPublicKey;
+ coin_sigs: EddsaSignature;
+ merchant_pub: EddsaPublicKey;
+ exchange_sig: EddsaSignature;
+ exchange_pub: EddsaPublicKey;
+ master_sig: EddsaSignature;
+ suppressed: boolean;
+ ancient: boolean;
}
.. note::
@@ -1520,19 +1359,11 @@ This API is used to obtain a list of denomination key validity withdraw inconsis
.. ts:def:: DenominationKeyValidityWithdrawInconsistency
interface DenominationKeyValidityWithdrawInconsistency {
-
-
- row_id : Integer;
-
- execution_date : Timestamp;
-
- reserve_pub : EddsaPublicKey;
-
- denompub_h : HashCode;
-
- suppressed : boolean;
-
-
+ row_id: Integer;
+ execution_date: Timestamp;
+ reserve_pub: EddsaPublicKey;
+ denompub_h: HashCode;
+ suppressed: boolean;
}
.. note::
@@ -1598,21 +1429,12 @@ This API is used to obtain a list of purses
.. ts:def:: Purses
interface Purses {
-
-
- auditor_purses_rowid : Integer;
-
- purse_pub : EddsaPublicKey;
-
- balance : Amount;
-
- target : Amount;
-
- expiration_date : Timestamp;
-
- suppressed : boolean;
-
-
+ auditor_purses_rowid: Integer;
+ purse_pub: EddsaPublicKey;
+ balance: Amount;
+ target: Amount;
+ expiration_date: Timestamp;
+ suppressed: boolean;
}
.. note::
@@ -1678,21 +1500,12 @@ This API is used to obtain a list of amount arithmetic inconsistencies
.. ts:def:: AmountArithmeticInconsistency
interface AmountArithmeticInconsistency {
-
-
- row_id : Integer;
-
- operation : string;
-
- exchange_amount : Amount;
-
- auditor_amount : Amount;
-
- profitable : boolean;
-
- suppressed : boolean;
-
-
+ row_id: Integer;
+ operation: string;
+ exchange_amount: Amount;
+ auditor_amount: Amount;
+ profitable: boolean;
+ suppressed: boolean;
}
.. note::
@@ -1758,19 +1571,11 @@ This API is used to obtain a list of historic denomination revenue
.. ts:def:: HistoricDenominationRevenue
interface HistoricDenominationRevenue {
-
-
- denom_pub_hash : HashCode;
-
- revenue_timestamp : Timestamp;
-
- revenue_balance : Amount;
-
- loss_balance : Amount;
-
- suppressed : boolean;
-
-
+ denom_pub_hash: HashCode;
+ revenue_timestamp: Timestamp;
+ revenue_balance: Amount;
+ loss_balance: Amount;
+ suppressed: boolean;
}
.. note::
@@ -1836,23 +1641,13 @@ This API is used to obtain a list of denomination pending
.. ts:def:: DenominationPending
interface DenominationPending {
-
-
- denom_pub_hash : HashCode;
-
- denom_balance : Amount;
-
- denom_loss : Amount;
-
- num_issued : Integer;
-
- denom_risk : Amount;
-
- recoup_loss : Amount;
-
- suppressed : boolean;
-
-
+ denom_pub_hash: HashCode;
+ denom_balance: Amount;
+ denom_loss: Amount;
+ num_issued: Integer;
+ denom_risk: Amount;
+ recoup_loss: Amount;
+ suppressed: boolean;
}
.. note::
@@ -1918,17 +1713,10 @@ This API is used to obtain a list of historic reserve summary
.. ts:def:: HistoricReserveSummary
interface HistoricReserveSummary {
-
-
- row_id : Integer;
-
- start_date : Timestamp;
-
- end_date : Timestamp;
-
- reserve_profits : Amount;
-
-
+ row_id: Integer;
+ start_date: Timestamp;
+ end_date: Timestamp;
+ reserve_profits: Amount;
}
.. note::
@@ -1994,21 +1782,12 @@ This API is used to obtain a list of exchange signkeys
.. ts:def:: ExchangeSignkeys
interface ExchangeSignkeys {
-
-
- exchange_pub : EddsaPublicKey;
-
- master_sig : EddsaSignature;
-
- ep_valid_from : Timestamp;
-
- ep_expire_sign : Timestamp;
-
- ep_expire_legal : Timestamp;
-
- suppressed : boolean;
-
-
+ exchange_pub: EddsaPublicKey;
+ master_sig: EddsaSignature;
+ ep_valid_from: Timestamp;
+ ep_expire_sign: Timestamp;
+ ep_expire_legal: Timestamp;
+ suppressed: boolean;
}
.. note::
@@ -2074,19 +1853,11 @@ This API is used to obtain a list of wire format inconsistencies
.. ts:def:: WireFormatInconsistency
interface WireFormatInconsistency {
-
-
- row_id : Integer;
-
- amount : Amount;
-
- wire_offset : Integer;
-
- diagnostic : string;
-
- suppressed : boolean;
-
-
+ row_id: Integer;
+ amount: Amount;
+ wire_offset: Integer;
+ diagnostic: string;
+ suppressed: boolean;
}
.. note::
@@ -2152,17 +1923,10 @@ This API is used to obtain a list of refreshes hanging
.. ts:def:: RefreshesHanging
interface RefreshesHanging {
-
-
- row_id : Integer;
-
- amount : Amount;
-
- coin_pub : EddsaPublicKey;
-
- suppressed : boolean;
-
-
+ row_id: Integer;
+ amount: Amount;
+ coin_pub: EddsaPublicKey;
+ suppressed: boolean;
}
.. note::
@@ -2228,23 +1992,13 @@ This API is used to obtain a list of emergencies
.. ts:def:: Emergency
interface Emergency {
-
-
- row_id : Integer;
-
- denompub_h : HashCode;
-
- denom_risk : Amount;
-
- denom_loss : Amount;
-
- deposit_start : Timestamp;
-
- deposit_end : Timestamp;
-
- value : Amount;
-
-
+ row_id: Integer;
+ denompub_h: HashCode;
+ denom_risk: Amount;
+ denom_loss: Amount;
+ deposit_start: Timestamp;
+ deposit_end: Timestamp;
+ value: Amount;
}
.. note::
@@ -2310,21 +2064,12 @@ This API is used to obtain a list of closure lags
.. ts:def:: ClosureLags
interface ClosureLags {
-
-
- row_id : Integer;
-
- amount : Amount;
-
- deadline : Timestamp;
-
- wtid : Integer;
-
- account : string;
-
- suppressed : boolean;
-
-
+ row_id: Integer;
+ amount: Amount;
+ deadline: Timestamp;
+ wtid: Integer;
+ account: string;
+ suppressed: boolean;
}
.. note::
@@ -2390,19 +2135,11 @@ This API is used to obtain a list of wire out inconsistencies
.. ts:def:: WireOutInconsistency
interface WireOutInconsistency {
-
-
- row_id : Integer;
-
- destination_account : string;
-
- expected : Amount;
-
- claimed : Amount;
-
- suppressed : boolean;
-
-
+ row_id: Integer;
+ destination_account: string;
+ expected: Amount;
+ claimed: Amount;
+ suppressed: boolean;
}
.. note::
@@ -2468,19 +2205,11 @@ This API is used to obtain a list of reserve balance summary wrong inconsistenci
.. ts:def:: ReserveBalanceSummaryWrongInconsistency
interface ReserveBalanceSummaryWrongInconsistency {
-
-
- row_id : Integer;
-
- reserve_pub : EddsaPublicKey;
-
- exchange_amount : Amount;
-
- auditor_amount : Amount;
-
- suppressed : boolean;
-
-
+ row_id: Integer;
+ reserve_pub: EddsaPublicKey;
+ exchange_amount: Amount;
+ auditor_amount: Amount;
+ suppressed: boolean;
}
.. note::
@@ -2546,17 +2275,10 @@ This API is used to obtain a list of row minor inconsistencies
.. ts:def:: RowMinorInconsistencies
interface RowMinorInconsistencies {
-
-
- row_id : Integer;
-
- row_table : Integer;
-
- diagnostic : string;
-
- suppressed : boolean;
-
-
+ row_id: Integer;
+ row_table: Integer;
+ diagnostic: string;
+ suppressed: boolean;
}
.. note::
