taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

get-monitoring-bad-sig-losses.rst (1851B)


      1 .. http:get:: /monitoring/bad-sig-losses
      2 
      3   Get a list of invalid signature losses 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   :query operation: A string. If specified, only returns eligible rows with this :ts:type:`BadSigLosses`.operation value. The default value is NULL which means to not filter by operation.
     13   :query op_spec_pub: An EddsaPublicKey (in base32 encoding). If given, use its value to only return rows with this :ts:type:`BadSigLosses`.operation_specific_pub value. The default value is NULL.
     14 
     15   With the default settings, the endpoint returns at most the 20 latest elements that are not suppressed.
     16 
     17   **Response:**
     18 
     19   :http:statuscode:`200 OK`:
     20     The auditor responds with a top level array of :ts:type:`BadSigLosses` objects.
     21 
     22   **Details:**
     23 
     24   .. ts:def:: BadSigLosses
     25 
     26     interface BadSigLosses {
     27 
     28       // Unique row identifier
     29       row_id : Integer;
     30 
     31       // Operation performed, even though a signature was invalid
     32       operation : string;
     33 
     34       // Amount considered lost by the exchange
     35       loss : Amount;
     36 
     37       // Public key associated with an operation
     38       operation_specific_pub : EddsaPublicKey;
     39 
     40       // True if this diagnostic was suppressed.
     41       suppressed : boolean;
     42 
     43     }
     44 
     45   .. note::
     46 
     47     This endpoint is still experimental. The endpoint will be further developed as needed.