diff options
Diffstat (limited to 'core/api-auditor.rst')
| -rw-r--r-- | core/api-auditor.rst | 25 |
1 files changed, 18 insertions, 7 deletions
diff --git a/core/api-auditor.rst b/core/api-auditor.rst index 9c2416a9..61e448b8 100644 --- a/core/api-auditor.rst +++ b/core/api-auditor.rst @@ -25,6 +25,7 @@ The `glossary <https://docs.taler.net/glossary.html#glossary>`_ defines all specific terms used in this section. .. contents:: Table of Contents + :local: .. _authentication: @@ -55,6 +56,7 @@ know-your-customer (KYC) registration before issuing contracts. .. http:get:: /config Get the protocol version and some meta data about the auditor. + This specification corresponds to ``current`` protocol being version **1**. **Response:** @@ -74,11 +76,19 @@ know-your-customer (KYC) registration before issuing contracts. // protocol is versioned independently of the exchange's protocol. version: string; + // URN of the implementation (needed to interpret 'revision' in version). + // @since v0, may become mandatory in the future. + implementation?: string; + // Return which currency this auditor is auditing for. currency: string; // EdDSA master public key of the auditor. auditor_public_key: EddsaPublicKey; + + // EdDSA master public key of the exchange. + // Added in protocol v1. + exchange_master_public_key: EddsaPublicKey; } .. note:: @@ -225,6 +235,7 @@ paid out first. // Master public key of the exchange corresponding to ``master_sig``. // Identifies the exchange this is about. + // @deprecated since v1 (now ignored, global per auditor) master_pub: EddsaPublicKey; // When does the validity of the exchange_pub end? @@ -340,14 +351,14 @@ This API is used to obtain a list of all the balances that are stored by the aud **Details:** - .. ts:def:: Balances + .. ts:def:: BalanceList interface BalanceList { // Total amount reported - auditor_total_reported_balance: taler_amount; + auditor_total_reported_balance: Amount; // Amount potentially missing - auditor_missing_balance: taler_amount; + auditor_missing_balance: Amount; //... } @@ -391,16 +402,16 @@ This API is used by the auditor to obtain a list of pending denominations interface PendingDenomination { // Balance of denomination. - denom_balance: taler_amount; + denom_balance: Amount; // Amount that was lost due to failures by the exchange. - denom_loss: taler_amount; + denom_loss: Amount; // Amount at risk of loss due to recoup operations. - denom_risk: taler_amount; + denom_risk: Amount; // Amount actually lost due to recoup operations after a revocation. - recoup_loss: taler_amount; + recoup_loss: Amount; } .. note:: |