taler-docs

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

commit 1a5b6f3e04ea32036e22c043eafd3654efb5fccc
parent b24ffb1440a4146412c6fe7bf79beb2338e439af
Author: Christian Grothoff <christian@grothoff.org>
Date:   Tue, 21 Feb 2023 17:49:59 +0100

Merge branch 'master' of git+ssh://git.taler.net/docs

Diffstat:
Mlibeufin/api-common.rst | 12++++++++++++
Mlibeufin/api-sandbox.rst | 11+++++------
Mlibeufin/local-currencies-tutorial.rst | 4++--
3 files changed, 19 insertions(+), 8 deletions(-)

diff --git 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 @@ -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; } diff --git a/libeufin/local-currencies-tutorial.rst b/libeufin/local-currencies-tutorial.rst @@ -29,7 +29,7 @@ All the commands mentioned in the following steps support a ``--help`` option that lists all the available options under the related command. If the configuration step succeeded, Sandbox should be ready to serve the -bank for a currency named `NB`. +bank for a currency named *NB*. In following step, we launch Sandbox by setting the administrator password as ``secret``. @@ -225,7 +225,7 @@ Check if the balance returned to zero with `this command <check-balance_>`_, and try again to delete the account `like already done <delete-account_>`_ Now the deletion command should have succeeded! -Try to `ask the balance <check-balance_>` again, and expect one +Try to `ask the balance <check-balance_>`_ again, and expect one error like the following: