taler-docs

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

commit b24472b8c0b970d5a7e8f83d947f94d887e86b2f
parent 5aa77bded4d911d6478ed24cc80a530b4b383855
Author: Christian Grothoff <christian@grothoff.org>
Date:   Tue, 27 May 2025 11:11:48 +0200

new single-commit refresh no longer has possibility for auditor to observe hanging refreshes

Diffstat:
Mcore/api-auditor.rst | 76----------------------------------------------------------------------------
1 file changed, 0 insertions(+), 76 deletions(-)

diff --git a/core/api-auditor.rst b/core/api-auditor.rst @@ -1589,82 +1589,6 @@ transfers). This endpoint is still experimental. The endpoint will be further developed as needed. -.. _refreshes-hanging-list: - -Refreshes Hanging ------------------ - -This section highlights cases, where a coin was melted but the reveal process -was not finished by the wallet. Usually, a wallet will do both requests in -rapid succession to refresh a coin. This might happen, even if the exchange -is operating correctly, if a wallet goes offline after melting. However, after -some time wallets should in most cases come back online and finish the -operation. If many operations are hanging, this might be indicative of a bug -(exchange failing on reveal, or wallets not implementing refresh correctly). - -.. http:get:: /monitoring/refreshes-hanging - - Get a list of refreshes hanging stored by the auditor. - - The following query parameters are optional, and can be used to customise the response: - - **Request:** - - :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. - :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. - :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. - - - With the default settings, the endpoint returns at most the 20 latest elements that are not suppressed. - - **Response:** - - :http:statuscode:`200 OK`: - The auditor responds with a top level array of :ts:type:`RefreshesHanging` objects. If no elements could be found, an empty array is returned - - **Details:** - - .. ts:def:: RefreshesHanging - - interface RefreshesHanging { - - // Unique row identifier - row_id : Integer; - - // Amount in coin not found in the exchange - amount : Amount; - - // Public key of coin - coin_pub : EddsaPublicKey; - - // True if this diagnostic was suppressed. - suppressed : boolean; - - } - - .. note:: - - This endpoint is still experimental. The endpoint will be further developed as needed. - - - - -.. http:patch:: /monitoring/refreshes-hanging/$SERIAL_ID - - This endpoint is used to suppress select elements of refreshes hanging. - Update the 'suppressed' field of a refreshes hanging element with row_id $SERIAL_ID, according to :ts:type:`GenericAuditorMonitorPatchRequest`, stored by the auditor. - - **Response:** - - :http:statuscode:`204 No Content`: - The element has been updated. - - .. note:: - - This endpoint is still experimental. The endpoint will be further developed as needed. - - - .. _closure-lags-list: