taler-docs

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

confirm-exchange-key-change.rst (1319B)

      1 .. ts:op:: confirmExchangeKeyChange
      2 
      3   Confirm that the exchange's changed key set is legitimate.
      4 
      5   The wallet has already adopted the changed key set; this releases
      6   the operations that send money to the exchange, which are withheld
      7   until the user has had a chance to notice that the key changed.
      8 
      9   **Request:**
     10 
     11   The request arguments must be a `ConfirmExchangeKeyChangeRequest`
     12   object.
     13 
     14   **Response:**
     15 
     16   On success, the result is an empty object.
     17 
     18   **Side effects:**
     19 
     20   Records the user's confirmation of the exchange's changed keys and
     21   releases the withheld operations that send money to the exchange.
     22 
     23   **Expected errors:**
     24 
     25   The caller can handle the following errors inline:
     26   ``WALLET_EXCHANGE_NO_KEY_CHANGE_PENDING``,
     27   ``WALLET_EXCHANGE_KEY_CHANGE_MISMATCH``.
     28 
     29   **Details:**
     30 
     31   ``currentMasterPub`` must be the master public key the exchange
     32   currently uses, so that a UI showing a stale key change cannot
     33   confirm a different one than the user was looking at.
     34 
     35 .. ts:def:: ConfirmExchangeKeyChangeRequest
     36 
     37   interface ConfirmExchangeKeyChangeRequest {
     38     exchangeBaseUrl: string;
     39 
     40     // Master public key the exchange now uses.  Required, so that a
     41     // UI showing a stale key change cannot confirm a different one
     42     // than the user was looking at.
     43     currentMasterPub: string;
     44   }