taler-docs

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

commit 63945799842c5ae3cfb6fbe7a323622092364091
parent c683a709e787431402c9a42997b597b235f687da
Author: Özgür Kesim <oec-taler@kesim.org>
Date:   Sat,  3 May 2025 13:27:50 +0200

[exchange] depricate /csr-melt

Diffstat:
Mcore/api-exchange.rst | 135++++++++++++++++++++++++++++++++++++++++---------------------------------------
1 file changed, 69 insertions(+), 66 deletions(-)

diff --git a/core/api-exchange.rst b/core/api-exchange.rst @@ -3448,71 +3448,6 @@ the exchange to achieve taxability, wallets do not really ever need that part of the API during normal operation. -.. http:post:: /csr-melt - - Obtain exchange-side input values in preparation for a - melt step for certain denomination cipher types, - specifically at this point for Clause-Schnorr blind - signatures. - - **Request:** The request body must be a `MeltPrepareRequest` object. - - **Response:** - - :http:statuscode:`200 OK`: - The request was successful, and the response is a `MeltPrepareResponse`. Note that repeating exactly the same request - will again yield the same response (assuming none of the denomination is expired). - :http:statuscode:`404 Not found`: - A denomination key is not known to the exchange. - :http:statuscode:`410 Gone`: - A requested denomination key is not yet or no longer valid. - It either before the validity start, past the expiration or was revoked. The response is a - `DenominationGoneMessage`. Clients must evaluate - the error code provided to understand which of the - cases this is and handle it accordingly. - - **Details:** - - .. ts:def:: MeltPrepareRequest - - interface MeltPrepareRequest { - - // Master seed for the Clause-schnorr R-value - // creation. - // Must not have been used in any prior request. - rms: RefreshMasterSeed; - - // Array of denominations and coin offsets for - // each of the fresh coins with a CS-cipher - // denomination. - nks: MeltPrepareDenomNonce[]; - - } - - .. ts:def:: MeltPrepareDenomNonce - - interface MeltPrepareDenomNonce { - - // Offset of this coin in the list of - // fresh coins. May not match the array offset - // as the fresh coins may include non-CS - // denominations as well. - coin_offset: Integer; - - // Hash of the public key of the denomination the - // request relates to. Must be a CS denomination type. - denom_pub_hash: HashCode; - } - - - .. ts:def:: MeltPrepareResponse - - interface MeltPrepareResponse { - // Responses for each request, in the same - // order that was used in the request. - ewvs: ExchangeWithdrawValue[]; - } - .. _melt: .. http:post:: /melt @@ -3593,7 +3528,7 @@ the API during normal operation. // matching the respective entries in ``denoms_h``. coin_evs: CoinEnvelope[][kappa]; - // Signature by the `coin <coin-priv>` over `TALER_MeltCommitmentPS`. + // Signature by the `coin <coin-priv>` over `TALER_RefreshMeltCoinAffirmationPS`. confirm_sig: EddsaSignature; } @@ -3654,6 +3589,74 @@ the API during normal operation. } +.. http:post:: /csr-melt + + .. note:: This endpoint is deprecated starting with API version v26. + Use ``/blinding-prepare`` instead. + + Obtain exchange-side input values in preparation for a + melt step for certain denomination cipher types, + specifically at this point for Clause-Schnorr blind + signatures. + + **Request:** The request body must be a `MeltPrepareRequest` object. + + **Response:** + + :http:statuscode:`200 OK`: + The request was successful, and the response is a `MeltPrepareResponse`. Note that repeating exactly the same request + will again yield the same response (assuming none of the denomination is expired). + :http:statuscode:`404 Not found`: + A denomination key is not known to the exchange. + :http:statuscode:`410 Gone`: + A requested denomination key is not yet or no longer valid. + It either before the validity start, past the expiration or was revoked. The response is a + `DenominationGoneMessage`. Clients must evaluate + the error code provided to understand which of the + cases this is and handle it accordingly. + + **Details:** + + .. ts:def:: MeltPrepareRequest + + interface MeltPrepareRequest { + + // Master seed for the Clause-schnorr R-value + // creation. + // Must not have been used in any prior request. + rms: RefreshMasterSeed; + + // Array of denominations and coin offsets for + // each of the fresh coins with a CS-cipher + // denomination. + nks: MeltPrepareDenomNonce[]; + + } + + .. ts:def:: MeltPrepareDenomNonce + + interface MeltPrepareDenomNonce { + + // Offset of this coin in the list of + // fresh coins. May not match the array offset + // as the fresh coins may include non-CS + // denominations as well. + coin_offset: Integer; + + // Hash of the public key of the denomination the + // request relates to. Must be a CS denomination type. + denom_pub_hash: HashCode; + } + + + .. ts:def:: MeltPrepareResponse + + interface MeltPrepareResponse { + // Responses for each request, in the same + // order that was used in the request. + ewvs: ExchangeWithdrawValue[]; + } + .. _pre26refresh: .. http:post:: /coins/$COIN_PUB/melt