summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2022-03-05 19:10:48 +0100
committerChristian Grothoff <christian@grothoff.org>2022-03-05 19:10:48 +0100
commit35ff3bcfd31e85f6731dbc545078c8c18c4748bb (patch)
tree3939844e04eff83fab61b67ea1921cdb607f38bc
parent66f5be59390274e51424f96916739cf785435c8c (diff)
downloaddocs-35ff3bcfd31e85f6731dbc545078c8c18c4748bb.tar.gz
docs-35ff3bcfd31e85f6731dbc545078c8c18c4748bb.tar.bz2
docs-35ff3bcfd31e85f6731dbc545078c8c18c4748bb.zip
update man pages and manuals to reflect new global-fee endpoints and commands
-rw-r--r--core/api-exchange.rst41
-rw-r--r--manpages/taler-exchange-offline.1.rst20
-rw-r--r--taler-exchange-manual.rst1
-rw-r--r--taler-exchange-setup-guide.rst5
4 files changed, 42 insertions, 25 deletions
diff --git a/core/api-exchange.rst b/core/api-exchange.rst
index 0dcdc776..a01c7a7f 100644
--- a/core/api-exchange.rst
+++ b/core/api-exchange.rst
@@ -483,9 +483,6 @@ possibly by using HTTPS.
// Public master key of the partner exchange.
partner_master_pub: EddsaPublicKey;
- // Wallet-to-wallet transfer wad fee charged.
- wad_fee: Amount;
-
// Exchange-to-exchange wad (wire) transfer frequency.
wad_frequency: RelativeTime;
@@ -872,6 +869,23 @@ Management operations authorized by master key
}
+.. http:post:: /management/global-fees
+
+ Provides global fee configuration for a timeframe.
+
+ **Request:**
+
+ The request must be a `GlobalFees` message.
+
+ **Response**
+
+ :http:statuscode:`204 No content`:
+ The configuration update has been processed successfully. The body is empty.
+ :http:statuscode:`403 Forbidden`:
+ The signature is invalid.
+ :http:statuscode:`409 Conflict`:
+ The exchange has previously received a conflicting configuration message.
+
.. http:post:: /management/wire
@@ -968,27 +982,6 @@ Management operations authorized by master key
}
-.. http:post:: /management/p2pfees
-
- Provides fee configuration for purses.
-
- .. note::
-
- This is a draft API that is not yet implemented.
-
- **Request:**
-
- The request must be a `P2PFees` message.
-
- **Response**
-
- :http:statuscode:`204 No content`:
- The configuration update has been processed successfully. The body is empty.
- :http:statuscode:`403 Forbidden`:
- The signature is invalid.
- :http:statuscode:`409 Conflict`:
- The exchange has previously received a conflicting configuration message.
-
.. http:post:: /management/partners
diff --git a/manpages/taler-exchange-offline.1.rst b/manpages/taler-exchange-offline.1.rst
index 66ee8044..265324e4 100644
--- a/manpages/taler-exchange-offline.1.rst
+++ b/manpages/taler-exchange-offline.1.rst
@@ -273,6 +273,26 @@ It outputs the signature affirming the wire fees, in a format suitable for the
``upload`` subcommand.
+global-fee
+----------
+
+This subcommand informs an exchange about the desired global fee structure and
+related global configuration options for a calendar year (!). The tool does
+not permit changing global fees during a calendar year. Also, once the global
+fee structure has been set for a calendar year, it cannot be changed.
+
+The subcommand takes the year, history fee, kyc fee, account fee, purse fee,
+purse timeout, kyc timeout, history expiration and the (free) purse (per)
+account limit as arguments. Instead of a year, the string ``now`` can be
+given for the current year (this is mostly useful for test cases). The fees
+must be given in the usual Taler format of ``CURRENCY:NUMBER.FRACTION``.
+
+The subcommand takes no inputs from ``stdin`` or other subcommands.
+
+It outputs the signature affirming the global fees, in a format suitable for
+the ``upload`` subcommand.
+
+
enable-partner
--------------
diff --git a/taler-exchange-manual.rst b/taler-exchange-manual.rst
index 753bd997..a45577a7 100644
--- a/taler-exchange-manual.rst
+++ b/taler-exchange-manual.rst
@@ -1050,6 +1050,7 @@ You can run a first simple benchmark using:
download sign \
enable-account payto://iban/CH9300762011623852957 \
wire-fee iban EUR:0 EUR:0 EUR:0 \
+ global-fee EUR:0 EUR:0 EUR:0 EUR:0 4w 4w 6y 4 \
upload
$ kill -TERM $HTTPD_PID
$ taler-exchange-benchmark -c benchmark.conf -p 4 -r 1 -n 10
diff --git a/taler-exchange-setup-guide.rst b/taler-exchange-setup-guide.rst
index 50908a08..67fdebfa 100644
--- a/taler-exchange-setup-guide.rst
+++ b/taler-exchange-setup-guide.rst
@@ -872,10 +872,13 @@ steps involving the offline signing machine must be completed:
[root@exchange-offline]# taler-exchange-offline \
enable-account payto://iban/$IBAN?receiver-name=$NAME > acct-response.json
[root@exchange-offline]# taler-exchange-offline \
- wire-fee 2021 iban EUR:0 EUR:0 > fee-response.json
+ wire-fee now iban EUR:0 EUR:0 EUR:0 > fee-response.json
+ [root@exchange-offline]# taler-exchange-offline \
+ global-fee now EUR:0 EUR:0 EUR:0 EUR:0 4w 4w 6y 4 > global-response.json
[root@exchange-online]# taler-exchange-offline upload < sig-response.json
[root@exchange-online]# taler-exchange-offline upload < acct-response.json
[root@exchange-online]# taler-exchange-offline upload < fee-response.json
+ [root@exchange-online]# taler-exchange-offline upload < global-response.json