[taler-docs] branch master updated: /wire endpoint died a long time ago, fix spec to match implementations, thanks to Mikolai for pointing it out

[gnunet]

This is an automated email from the git hooks/post-receive script.

grothoff pushed a commit to branch master
in repository docs.

The following commit(s) were added to refs/heads/master by this push:
     new ab72f734 /wire endpoint died a long time ago, fix spec to match 
implementations, thanks to Mikolai for pointing it out
ab72f734 is described below

commit ab72f7349e965768ade45b5edd68c31d1cf8298a
Author: Christian Grothoff <christian@grothoff.org>
AuthorDate: Thu Feb 8 16:36:46 2024 +0100

    /wire endpoint died a long time ago, fix spec to match implementations, 
thanks to Mikolai for pointing it out
---
 core/api-exchange.rst | 187 ++++++++++++++++++++------------------------------
 1 file changed, 76 insertions(+), 111 deletions(-)

diff --git a/core/api-exchange.rst b/core/api-exchange.rst
index 404e9706..0e79ae6b 100644
--- a/core/api-exchange.rst
+++ b/core/api-exchange.rst
@@ -255,6 +255,79 @@ possibly by using HTTPS.
 
     }
 
+  The specification for the account object is:
+
+  .. ts:def:: WireAccount
+
+    interface WireAccount {
+      // ``payto://`` URI identifying the account and wire method
+      payto_uri: string;
+
+      // URI to convert amounts from or to the currency used by
+      // this wire account of the exchange. Missing if no
+      // conversion is applicable.
+      conversion_url?: string;
+
+      // Restrictions that apply to bank accounts that would send
+      // funds to the exchange (crediting this exchange bank account).
+      // Optional, empty array for unrestricted.
+      credit_restrictions: AccountRestriction[];
+
+      // Restrictions that apply to bank accounts that would receive
+      // funds from the exchange (debiting this exchange bank account).
+      // Optional, empty array for unrestricted.
+      debit_restrictions: AccountRestriction[];
+
+      // Signature using the exchange's offline key over
+      // a `TALER_MasterWireDetailsPS`
+      // with purpose ``TALER_SIGNATURE_MASTER_WIRE_DETAILS``.
+      master_sig: EddsaSignature;
+    }
+
+  .. ts:def:: AccountRestriction
+
+    type AccountRestriction =
+      | RegexAccountRestriction
+      | DenyAllAccountRestriction
+
+  .. ts:def:: DenyAllAccountRestriction
+
+    // Account restriction that disables this type of
+    // account for the indicated operation categorically.
+    interface DenyAllAccountRestriction {
+
+      type: "deny";
+    }
+
+  .. ts:def:: RegexAccountRestriction
+
+    // Accounts interacting with this type of account
+    // restriction must have a payto://-URI matching
+    // the given regex.
+    interface RegexAccountRestriction {
+
+      type: "regex";
+
+      // Regular expression that the payto://-URI of the
+      // partner account must follow.  The regular expression
+      // should follow posix-egrep, but without support for character
+      // classes, GNU extensions, back-references or intervals. See
+      // 
https://www.gnu.org/software/findutils/manual/html_node/find_html/posix_002degrep-regular-expression-syntax.html
+      // for a description of the posix-egrep syntax. Applications
+      // may support regexes with additional features, but exchanges
+      // must not use such regexes.
+      payto_regex: string;
+
+      // Hint for a human to understand the restriction
+      // (that is hopefully easier to comprehend than the regex itself).
+      human_hint: string;
+
+      // Map from IETF BCP 47 language tags to localized
+      // human hints.
+      human_hint_i18n?: { [lang_tag: string]: string };
+
+    }
+
   .. ts:def:: GlobalFees
 
     interface GlobalFees {
@@ -542,114 +615,6 @@ possibly by using HTTPS.
     Both the individual denominations *and* the denomination list is signed,
     allowing customers to prove that they received an inconsistent list.
 
-.. _wire-req:
-
-.. http:get:: /wire
-
-  Returns a list of payment methods supported by the exchange.  The idea is
-  that wallets may use this information to instruct users on how to perform
-  wire transfers to top up their wallets.
-
-  **Response:**
-
-  :http:statuscode:`200 OK`:
-     The exchange responds with a `WireResponse` object. This request should 
virtually always be successful.
-
-  **Details:**
-
-  .. ts:def:: WireResponse
-
-    interface WireResponse {
-
-      // Master public key of the exchange, must match the key returned in 
``/keys``.
-      master_public_key: EddsaPublicKey;
-
-      // Array of wire accounts operated by the exchange for
-      // incoming wire transfers.
-      accounts: WireAccount[];
-
-      // Object mapping names of wire methods (i.e. "iban" or "x-taler-bank")
-      // to wire fees.
-      fees: { method : AggregateTransferFee[] };
-
-      // List of exchanges that this exchange is partnering
-      // with to enable wallet-to-wallet transfers.
-      wads: ExchangePartner[];
-    }
-
-  The specification for the account object is:
-
-  .. ts:def:: WireAccount
-
-    interface WireAccount {
-      // ``payto://`` URI identifying the account and wire method
-      payto_uri: string;
-
-      // URI to convert amounts from or to the currency used by
-      // this wire account of the exchange. Missing if no
-      // conversion is applicable.
-      conversion_url?: string;
-
-      // Restrictions that apply to bank accounts that would send
-      // funds to the exchange (crediting this exchange bank account).
-      // Optional, empty array for unrestricted.
-      credit_restrictions: AccountRestriction[];
-
-      // Restrictions that apply to bank accounts that would receive
-      // funds from the exchange (debiting this exchange bank account).
-      // Optional, empty array for unrestricted.
-      debit_restrictions: AccountRestriction[];
-
-      // Signature using the exchange's offline key over
-      // a `TALER_MasterWireDetailsPS`
-      // with purpose ``TALER_SIGNATURE_MASTER_WIRE_DETAILS``.
-      master_sig: EddsaSignature;
-    }
-
-  .. ts:def:: AccountRestriction
-
-    type AccountRestriction =
-      | RegexAccountRestriction
-      | DenyAllAccountRestriction
-
-  .. ts:def:: DenyAllAccountRestriction
-
-    // Account restriction that disables this type of
-    // account for the indicated operation categorically.
-    interface DenyAllAccountRestriction {
-
-      type: "deny";
-    }
-
-  .. ts:def:: RegexAccountRestriction
-
-    // Accounts interacting with this type of account
-    // restriction must have a payto://-URI matching
-    // the given regex.
-    interface RegexAccountRestriction {
-
-      type: "regex";
-
-      // Regular expression that the payto://-URI of the
-      // partner account must follow.  The regular expression
-      // should follow posix-egrep, but without support for character
-      // classes, GNU extensions, back-references or intervals. See
-      // 
https://www.gnu.org/software/findutils/manual/html_node/find_html/posix_002degrep-regular-expression-syntax.html
-      // for a description of the posix-egrep syntax. Applications
-      // may support regexes with additional features, but exchanges
-      // must not use such regexes.
-      payto_regex: string;
-
-      // Hint for a human to understand the restriction
-      // (that is hopefully easier to comprehend than the regex itself).
-      human_hint: string;
-
-      // Map from IETF BCP 47 language tags to localized
-      // human hints.
-      human_hint_i18n?: { [lang_tag: string]: string };
-
-    }
-
   Aggregate wire transfer fees representing the fees the exchange
   charges per wire transfer to a merchant must be specified as an
   array in all wire transfer response objects under ``fees``.  The
@@ -664,9 +629,6 @@ possibly by using HTTPS.
       // Per transfer closing fee.
       closing_fee: Amount;
 
-      // Per exchange-to-exchange transfer (wad) fee.
-      wad_fee: Amount;
-
       // What date (inclusive) does this fee go into effect?
       // The different fees must cover the full time period in which
       // any of the denomination keys are valid without overlap.
@@ -691,6 +653,9 @@ possibly by using HTTPS.
       // Public master key of the partner exchange.
       partner_master_pub: EddsaPublicKey;
 
+      // Per exchange-to-exchange transfer (wad) fee.
+      wad_fee: Amount;
+
       // Exchange-to-exchange wad (wire) transfer frequency.
       wad_frequency: RelativeTime;
 

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.