[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[taler-docs] branch master updated: circuit API tutorial
From: |
gnunet |
Subject: |
[taler-docs] branch master updated: circuit API tutorial |
Date: |
Tue, 17 Jan 2023 10:27:57 +0100 |
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 c544a4d circuit API tutorial
c544a4d is described below
commit c544a4d84efe03b6905173a48edea54851424681
Author: MS <ms@taler.net>
AuthorDate: Tue Jan 17 10:25:58 2023 +0100
circuit API tutorial
pointing to all the available commands that
use the API and to the example scripts that
provide the SMS and e-mail TAN channels.
---
libeufin/local-currencies-tutorial.rst | 33 ++++++++++++++++++++++-----------
1 file changed, 22 insertions(+), 11 deletions(-)
diff --git a/libeufin/local-currencies-tutorial.rst
b/libeufin/local-currencies-tutorial.rst
index e09a622..f2b55be 100644
--- a/libeufin/local-currencies-tutorial.rst
+++ b/libeufin/local-currencies-tutorial.rst
@@ -27,16 +27,14 @@ configure *Sandbox* (= the service acting as the bank) with
the following comman
.. note::
The ``--without-registrations`` option allows *only the administrator*
- to add new accounts.
+ to add new accounts. Without this option, other APIs may offer
+ unrestricted registrations.
-.. note::
-
- All the commands mentioned in the following steps
- support a ``--help`` option that lists all the available
- options under such command.
+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`.
+If the configuration step succeeded, Sandbox should be ready to serve the
+bank for a currency named `NB`.
In following step, we launch Sandbox by setting the administrator
password as ``secret``.
@@ -45,9 +43,7 @@ password as ``secret``.
The following command launches Sandbox so that it writes
TANs on the filesystem to ease the cash-out operations without
- relying on an actual e-mail or SMS provider. See section
- FIXME for e-mail or SMS based TANs.
-
+ relying on an `actual e-mail or SMS provider <email-sms-setup_>`_.
.. code-block:: console
$ export LIBEUFIN_SANDBOX_ADMIN_PASSWORD=secret
@@ -243,6 +239,16 @@ 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
-----------------------
@@ -277,3 +283,8 @@ phone number / e-mail address as their first command line
argument.
The way the invoked commands interact with their providers
is out of the Sandbox scope.
+
+Finally, Libeufin ships two TAN commands as example. The e-mail
+command relies on `GNU mail <mailutils.org>`_ and the SMS command
+on the service offered by `<telesign.com>`_. Check
``contrib/libeufin-tan-sms.sh``
+and ``contrib/libeufin-tan-email.sh`` in the Libeufin repository.
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.