taler-docs

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

add-global-currency-auditor.rst (790B)

      1 .. ts:op:: addGlobalCurrencyAuditor
      2 
      3   Register a trusted auditor for a global currency.
      4 
      5   **Request:**
      6 
      7     The request must be an `AddGlobalCurrencyAuditorRequest` object.
      8 
      9   **Response:**
     10 
     11     On success, the result is an empty object (`EmptyObject`).
     12 
     13   **Side effects:**
     14 
     15     Registers the auditor for the global currency in the wallet's
     16     database.  When the configuration changed, a ``balance-change``
     17     notification is emitted.
     18 
     19   **Details:**
     20 
     21     Adding an auditor that is already registered is a no-op.  The
     22     ``auditorBaseUrl`` must be a canonicalized base URL (see
     23     :ts:op:`canonicalizeBaseUrl`).
     24 
     25 .. ts:def:: AddGlobalCurrencyAuditorRequest
     26 
     27   interface AddGlobalCurrencyAuditorRequest {
     28     currency: string;
     29     auditorBaseUrl: string;
     30     auditorPub: string;
     31   }