summaryrefslogtreecommitdiff
path: root/libeufin
diff options
context:
space:
mode:
authorMS <ms@taler.net>2023-02-21 13:07:12 +0100
committerMS <ms@taler.net>2023-02-21 13:07:20 +0100
commit606d25c3f17e219334ba744970843902f8d4117f (patch)
treea977043b230efd7f197c6929ebb8d584eb16765c /libeufin
parentf1b3d8742d5675423d84a9f6185b5fdfa5cb9b45 (diff)
downloaddocs-606d25c3f17e219334ba744970843902f8d4117f.tar.gz
docs-606d25c3f17e219334ba744970843902f8d4117f.tar.bz2
docs-606d25c3f17e219334ba744970843902f8d4117f.zip
fix warnings
Diffstat (limited to 'libeufin')
-rw-r--r--libeufin/api-common.rst12
-rw-r--r--libeufin/api-sandbox.rst11
2 files changed, 17 insertions, 6 deletions
diff --git a/libeufin/api-common.rst b/libeufin/api-common.rst
index 3bfb4572..83da130f 100644
--- a/libeufin/api-common.rst
+++ b/libeufin/api-common.rst
@@ -16,6 +16,18 @@ Contact details
Phone numbers should start with the ``+`` symbol and the country code.
+Ratios and Fees
+^^^^^^^^^^^^^^^
+
+.. ts:def:: LibeufinNumber
+
+ type LibeufinNumber = number;
+
+**Note:** this quantity is normally enforced to have at most
+two decimal digits. The reason is to preserve the 2-decimal
+digits policy of the `Amount` type, as `LibeufinNumber` is used
+to multiply `Amount`.
+
Amounts
^^^^^^^
diff --git a/libeufin/api-sandbox.rst b/libeufin/api-sandbox.rst
index 91cece91..847d2606 100644
--- a/libeufin/api-sandbox.rst
+++ b/libeufin/api-sandbox.rst
@@ -410,8 +410,7 @@ Cashouts
:http:statuscode:`409 Conflict`:
At least the following two cases are possible
* an institutional user (``admin`` or ``bank``) tried the operation
- * the user changed their cash-out address between the creation
- and the confirmation of ``$cashoutId``.
+ * the user changed their cash-out address between the creation and the confirmation of ``$cashoutId``.
:http:statuscode:`412 Precondition failed`:
``$cashoutId`` was already confirmed.
@@ -440,13 +439,13 @@ Cashouts
interface RatiosAndFees {
// Exchange rate to buy the circuit currency from fiat.
- buy_at_ratio: float;
+ buy_at_ratio: LibeufinNumber;
// Exchange rate to sell the circuit currency for fiat.
- sell_at_ratio: float;
+ sell_at_ratio: LibeufinNumber;
// Fee to subtract after applying the buy ratio.
- buy_in_fee: float;
+ buy_in_fee: LibeufinNumber;
// Fee to subtract after applying the sell ratio.
- sell_out_fee: float;
+ sell_out_fee: LibeufinNumber;
}