[taler-docs] branch master updated: circuit tutorial

[gnunet]

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

ms pushed a commit to branch master
in repository docs.

The following commit(s) were added to refs/heads/master by this push:
     new 988c3e1  circuit tutorial
988c3e1 is described below

commit 988c3e1ff0ca343e864a51d827930572aac99151
Author: MS <ms@taler.net>
AuthorDate: Mon Jan 30 19:33:11 2023 +0100

    circuit tutorial
    
    addressing Florian's review
---
 libeufin/local-currencies-tutorial.rst | 50 ++++++++++++++--------------------
 1 file changed, 21 insertions(+), 29 deletions(-)

diff --git a/libeufin/local-currencies-tutorial.rst 
b/libeufin/local-currencies-tutorial.rst
index f2b55be..8ec1325 100644
--- a/libeufin/local-currencies-tutorial.rst
+++ b/libeufin/local-currencies-tutorial.rst
@@ -1,23 +1,18 @@
 Create a local currency (experimental)
 ######################################
 
-The following commands are based on the :ref:`Circuit API <circuit-api>`,
-that allows to register merchants to participate
-in a local currency circuit.  The main difference with ordinary
-registrations is that this API offers to associate a `cash-out`
-address to the account, so that merchants can convert the local
-currency back to their fiat bank account.
-
-The following commands show a minimal use case where the
-administrator adds a merchant to the circuit, then this latter
-would cash-out their assets, and finally the administrator
-deletes the merchant account.
-
-More general information about libEufin can be found in the
+This LibEuFin tutorial shows how to manage a bank account
+in the local currency, and how to convert assets from the
+local to the fiat currency.  Such conversion is called *cash-out*.
+
+This tutorial is based on the :ref:`Circuit API <circuit-api>`,
+and more general information about libEufin can be found in the
 :doc:`How-To page </libeufin/nexus-tutorial>`.
 
-After having built libEufin (see :ref:`dedicate section 
<building-from-source>`),
-configure *Sandbox* (= the service acting as the bank) with the following 
command.
+The first step is :ref:`building LibEuFin <building-from-source>`.
+
+If the installation succeeded, configure *Sandbox* (= the service
+acting as the bank) with the following command.
 
 .. code-block:: console
 
@@ -79,7 +74,11 @@ If the previous step succeeded, the merchant should have
 access to their bank account with the *circuit-shop* username
 and *shop-secret* password.
 
-Check it by asking the merchant balance with this command:
+Check it by asking the merchant balance with the following command.
+The two environment variables LIBEUFIN_SANDBOX_USERNAME and
+LIBEUFIN_SANDBOX_PASSWORD instruct the CLI to authenticate as the
+merchant.
+
 
 .. _check-balance:
 
@@ -183,7 +182,7 @@ the local currency circuit.  For the deletion to succeed,
 the account must have a balance of zero NB.  Because
 of the cash-out operation, the merchant has now -1 NB
 to their account, therefore the deletion will fail.  Check
-it with the following command:
+it, as the administrator, with the following command
 
 
 .. _delete-account:
@@ -211,8 +210,8 @@ The expected output is:
 
 
 The bank may now award 1 NB to the merchant to bring their
-balance to zero and finally delete the account.  The following
-command awards 1 NB to the merchant.
+balance to zero and finally delete the account.  With the following
+command, the administrator awards 1 NB to the merchant.
 
 .. code-block:: console
 
@@ -225,8 +224,9 @@ command awards 1 NB to the merchant.
 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 succeed!  Try asking
-again the balance, and expect one error like the following:
+Now the deletion command should have succeeded!
+Try to `ask the balance <check-balance_>` again, and expect one
+error like the following:
 
 
 .. code-block:: console
@@ -239,14 +239,6 @@ again the balance, and expect one error like the following:
    }
 
 
-Finally, the following command shows a list that includes all
-the operations that use the Circuit API: those named ``circuit-*``.
-
-.. code-block:: console
-
-   libeufin-cli sandbox demobank
-
-
 .. _email-sms-setup:
 
 E-mail or SMS TAN setup

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