taler-docs

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

commit 87b3a942163301022cf091d07dfcc71233d5b0c3
parent 20b631639ff2531a8717ce4df8fd09e80d0654fa
Author: Christian Grothoff <christian@grothoff.org>
Date:   Wed, 23 Aug 2023 21:28:41 +0200

update documentation

Diffstat:
Mcore/api-merchant.rst | 61+++++++++++++------------------------------------------------
Mmanpages/taler.conf.5.rst | 7++-----
2 files changed, 15 insertions(+), 53 deletions(-)

diff --git a/core/api-merchant.rst b/core/api-merchant.rst @@ -955,17 +955,10 @@ Setting up instances // (to be put into contracts). jurisdiction: Location; - // Maximum wire fee this instance is willing to pay. - // Can be overridden by the frontend on a per-order basis. - default_max_wire_fee: Amount; - - // Default factor for wire fee amortization calculations. - // Can be overridden by the frontend on a per-order basis. - default_wire_fee_amortization: Integer; - - // Maximum deposit fee (sum over all coins) this instance is willing to pay. - // Can be overridden by the frontend on a per-order basis. - default_max_deposit_fee: Amount; + // Use STEFAN curves to determine default fees? + // If false, no fees are allowed by default. + // Can always be overridden by the frontend on a per-order basis. + use_stefan: boolean; // If the frontend does NOT specify an execution date, how long should // we tell the exchange to wait to aggregate transactions before @@ -1122,17 +1115,10 @@ Setting up instances // (to be put into contracts). jurisdiction: Location; - // Maximum wire fee this instance is willing to pay. - // Can be overridden by the frontend on a per-order basis. - default_max_wire_fee: Amount; - - // Default factor for wire fee amortization calculations. - // Can be overridden by the frontend on a per-order basis. - default_wire_fee_amortization: Integer; - - // Maximum deposit fee (sum over all coins) this instance is willing to pay. - // Can be overridden by the frontend on a per-order basis. - default_max_deposit_fee: Amount; + // Use STEFAN curves to determine default fees? + // If false, no fees are allowed by default. + // Can always be overridden by the frontend on a per-order basis. + use_stefan: boolean; // If the frontend does NOT specify an execution date, how long should // we tell the exchange to wait to aggregate transactions before @@ -1251,17 +1237,10 @@ Inspecting instances // (to be put into contracts). jurisdiction: Location; - // Maximum wire fee this instance is willing to pay. - // Can be overridden by the frontend on a per-order basis. - default_max_wire_fee: Amount; - - // Default factor for wire fee amortization calculations. - // Can be overridden by the frontend on a per-order basis. - default_wire_fee_amortization: Integer; - - // Maximum deposit fee (sum over all coins) this instance is willing to pay. - // Can be overridden by the frontend on a per-order basis. - default_max_deposit_fee: Amount; + // Use STEFAN curves to determine default fees? + // If false, no fees are allowed by default. + // Can always be overridden by the frontend on a per-order basis. + use_stefan: boolean; // If the frontend does NOT specify an execution date, how long should // we tell the exchange to wait to aggregate transactions before @@ -3460,23 +3439,9 @@ The contract terms must have the following structure: fulfillment_message_i18n?: { [lang_tag: string]: string }; // Maximum total deposit fee accepted by the merchant for this contract. + // Overrides defaults of the merchant instance. max_fee: Amount; - // Maximum wire fee accepted by the merchant (customer share to be - // divided by the ``wire_fee_amortization`` factor, and further reduced - // if deposit fees are below ``max_fee``). Default if missing is zero. - max_wire_fee: Amount; - - // Over how many customer transactions does the merchant expect to - // amortize wire fees on average? If the exchange's wire fee is - // above ``max_wire_fee``, the difference is divided by this number - // to compute the expected customer's contribution to the wire fee. - // The customer's contribution may further be reduced by the difference - // between the ``max_fee`` and the sum of the actual deposit fees. - // Optional, default value if missing is 1. 0 and negative values are - // invalid and also interpreted as 1. - wire_fee_amortization: number; - // List of products that are part of the purchase (see `Product`). products: Product[]; diff --git a/manpages/taler.conf.5.rst b/manpages/taler.conf.5.rst @@ -95,10 +95,6 @@ MASTER_PUBLIC_KEY Crockford Base32-encoded master public key, public version of the exchange's long-time offline signing key. -MASTER_PRIV_FILE - Location of the master private key on disk. Only used by tools that - can be run offline (as the master key is for offline signing). - AML_THRESHOLD Largest amount in this currency that can be transferred per month without an AML staff member doing a (manual) AML check. For example: "USD:1000000". @@ -351,7 +347,8 @@ EXCHANGE OFFLINE SIGNING OPTIONS The following options must be in the section "[exchange-offline]". MASTER_PRIV_FILE - Where to store the offline private key of the exchange. + Location of the master private key on disk. Only used by tools that + can be run offline (as the master key is for offline signing). Mandatory. SECM_TOFU_FILE