get-monitoring-coin-inconsistency.rst (1618B)
1 .. http:get:: /monitoring/coin-inconsistency 2 3 Get a list of coin inconsistencies stored by the auditor. 4 5 The following query parameters are optional, and can be used to customise the response: 6 7 **Request:** 8 9 :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. 10 :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. 11 :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false. 12 13 14 With the default settings, the endpoint returns at most the 20 latest elements that are not suppressed. 15 16 **Response:** 17 18 :http:statuscode:`200 OK`: 19 The auditor responds with a top level array of :ts:type:`CoinInconsistency` objects. 20 21 **Details:** 22 23 .. ts:def:: CoinInconsistency 24 25 interface CoinInconsistency { 26 27 // Unique row identifier 28 row_id : Integer; 29 30 // The operation performed by the exchange 31 operation : string; 32 33 // Total the exchange calculated 34 exchange_amount : Amount; 35 36 // Total the auditor calculated 37 auditor_amount : Amount; 38 39 // Public key of the coin in question 40 coin_pub : EddsaPublicKey; 41 42 // Whether this arithmetic error was profitable for the exchange 43 profitable : boolean; 44 45 // True if this diagnostic was suppressed. 46 suppressed : boolean; 47 48 } 49 50 .. note:: 51 52 This endpoint is still experimental. The endpoint will be further developed as needed.