summaryrefslogtreecommitdiff
path: root/core/api-exchange.rst
diff options
context:
space:
mode:
authorÖzgür Kesim <oec-taler@kesim.org>2022-10-05 09:30:01 +0200
committerÖzgür Kesim <oec-taler@kesim.org>2022-10-05 09:30:01 +0200
commit5ebdef1e17d86a890f8c898c16a4b5f1d05ebd3d (patch)
tree5d297b3c016c93cb6be412b620f1efbb49f4a724 /core/api-exchange.rst
parent4ea5d93b8bbe6424f0bf484dd9ac986c83d27d00 (diff)
downloaddocs-5ebdef1e17d86a890f8c898c16a4b5f1d05ebd3d.tar.gz
docs-5ebdef1e17d86a890f8c898c16a4b5f1d05ebd3d.tar.bz2
docs-5ebdef1e17d86a890f8c898c16a4b5f1d05ebd3d.zip
Updates to Policy* definitions
Diffstat (limited to 'core/api-exchange.rst')
-rw-r--r--core/api-exchange.rst32
1 files changed, 14 insertions, 18 deletions
diff --git a/core/api-exchange.rst b/core/api-exchange.rst
index fb6572dc..011c4a51 100644
--- a/core/api-exchange.rst
+++ b/core/api-exchange.rst
@@ -2116,6 +2116,9 @@ proof to the seller for the escrow of sufficient fund.
// EdDSA `public key of the merchant <merchant-pub>`, so that the client can identify the
// merchant for refund requests.
+ //
+ // THIS FIELD WILL BE DEPRICATED, once the refund mechanism becomes a
+ // policy via extension.
merchant_pub: EddsaPublicKey;
// Date until which the merchant can issue a refund to the customer via the
@@ -2167,7 +2170,7 @@ proof to the seller for the escrow of sufficient fund.
type DepositPolicy =
| PolicyRefund
- | PolicyAuction
+ | PolicyBrandtVickereyAuction
| PolicyEscrow;
.. ts:def:: PolicyRefund
@@ -2179,30 +2182,29 @@ proof to the seller for the escrow of sufficient fund.
interface PolicyRefund {
type: "refund";
+ // EdDSA `public key of the merchant <merchant-pub>`, so that the client can identify the
+ // merchant for refund requests.
+ merchant_pub: EddsaPublicKey;
+
// Date until which the merchant can issue a refund to the customer via
// the ``/extensions/policy_refund``-endpoint of the exchange.
deadline: Timestamp;
}
- .. ts:def:: PolicyAuction
+ .. ts:def:: PolicyBrandtVickereyAuction
// CAVEAT: THIS IS STILL WORK IN PROGRESS.
// This policy is optional and might not be supported by the exchange.
// If it does, the exchange MUST show support for this policy in the
// ``extensions`` field in the response to ``/keys``.
- interface PolicyAuction {
+ interface PolicyVickereyAuction {
type: "auction";
// Public key of this bidder.
//
// The bidder uses this key to sign the auction information and
// the messages it sends to the seller during the auction.
- bidder_key: EddsaPublicKey;
-
- // Signature of the ``h_contract_terms`` from the `DepositRequest`
- // (here, the hash of the auction information), signed by the bidder's
- // private key.
- h_auction_sig: EddsaSignature;
+ bidder_pub: EddsaPublicKey;
// Date until the auction must have been successfully executed and
// a valid transcript provided to the ``/extensions/policy_auction``
@@ -2236,18 +2238,12 @@ proof to the seller for the escrow of sufficient fund.
// key, to the ``/extensions/policy_escrow``-endpoint of the exchange,
// after the date specified in ``not_before`` and before the date
// specified in ``not_after``.
- trustor_key: EddsaPublicKey;
-
- // Earliest date before the deposit can be claimed by the merchant.
- // Any attempts to claim this deposit before that date is ignored.
- // Must lie before the date specified in ``not_after``.
- not_before: Timestamp;
+ trustor_pub: EddsaPublicKey;
// Latest date by which the deposit must be claimed. If the deposit
- // has not been claimed by that date, the deposited coins can be
+ // has not been claimed by that date, the deposited coins can be
// refreshed by the (still) owner.
- // Must lie after the date specified in ``not_before``.
- not_after: Timestamp;
+ deadline: Timestamp;
}