commit 74677857773059392241179aa3658205096a9def
parent eafdf52131f8635b523163c35786e97101e1b871
Author: Christian Grothoff <christian@grothoff.org>
Date: Sun, 24 Sep 2023 19:21:08 +0200
fix build
Diffstat:
7 files changed, 36 insertions(+), 34 deletions(-)
diff --git a/core/api-donau.rst b/core/api-donau.rst
@@ -15,9 +15,9 @@
@author Christian Grothoff
-========================
+=====================
The Donau RESTful API
-========================
+=====================
The API specified here follows the :ref:`general conventions <http-common>`
for all details not specified in the individual requests.
@@ -28,11 +28,11 @@ defines all specific terms used in this section.
.. include:: tos.rst
-.. _keys:
+.. _donau_status:
----------------------------
+------------------------
Donau status information
----------------------------
+------------------------
This API is used by wallets and merchants to obtain global information about
the donau, such as online signing keys, available denominations and the fee
@@ -1353,5 +1353,3 @@ proof to the seller for the escrow of sufficient fund.
// deadline, or as soon as possible if the refund deadline is zero.
donau_sig: EddsaSignature;
}
-
-
diff --git a/core/api-exchange.rst b/core/api-exchange.rst
@@ -2963,7 +2963,7 @@ proof to the seller for the escrow of sufficient fund.
:http:statuscode:`200 OK`:
The operation succeeded, the exchange confirms that no double-spending took
- place. The response will include a `BatchDepositSuccess` object.
+ place. The response will include a `DepositSuccess` object.
:http:statuscode:`403 Forbidden`:
One of the signatures is invalid.
This response comes with a standard `ErrorDetail` response.
@@ -3225,9 +3225,9 @@ proof to the seller for the escrow of sufficient fund.
The deposit operation succeeds if the coin is valid for making a deposit and
has enough residual value that has not already been deposited or melted.
- .. ts:def:: BatchDepositSuccess
+ .. ts:def:: DepositSuccess
- interface BatchDepositSuccess {
+ interface DepositSuccess {
// Optional base URL of the exchange for looking up wire transfers
// associated with this transaction. If not given,
// the base URL is the same as the one used for this request.
diff --git a/core/api-overview.rst b/core/api-overview.rst
@@ -57,14 +57,7 @@ Overview
* **Providers**: wallet-core
* **Consumers**: UIs for the GNU Taler wallet
-.. rubric:: Taler Bank Integration API
-
-* **Summary**: Offered by banks to provide the wallet/user with more information about ongoing withdrawals of Taler digital cash.
-* **Providers**: Taler fakebank, LibEuFin demobank, Banks (that provide extra Taler support)
-* **Consumers**: Taler Wallet
-* :doc:`Docs <api-bank-integration>`
-
-.. rubric:: Libefin Bank API
+.. rubric:: Core Bank API
* **Summary**: Protocol to manage a simple core bank with optional regional
currency support. Allows access to a bank account by the owner of the
@@ -72,8 +65,14 @@ Overview
payments.
* **Providers**: LibEuFin demobank, Taler Fakebank (partial)
* **Consumers**: Cashier App, demobank-ui
-* :doc:`Docs <api-libeufin-bank>`
+* :doc:`Docs <api-corebank>`
+.. rubric:: Taler Bank Integration API
+
+* **Summary**: Offered by banks to provide the wallet/user with more information about ongoing withdrawals of Taler digital cash.
+* **Providers**: Taler fakebank, LibEuFin demobank, Banks (that provide extra Taler support)
+* **Consumers**: Taler Wallet
+* :doc:`Docs <api-bank-integration>`
.. rubric:: Taler Wire Gateway API
@@ -85,6 +84,14 @@ Overview
* :doc:`Docs <api-bank-wire>`
+.. rubric:: Taler Bank Revenue API
+
+* **Summary**: Offered by banks to provide clients the ability to download credit transaction histories.
+* **Providers**: Taler fakebank, LibEuFin demobank, Banks (that provide extra Taler support)
+* **Consumers**: Taler Merchant, GNU Anastasis
+* :doc:`Docs <api-bank-revenue>`
+
+
.. rubric:: Taler Sync API
* **Summary**: Encrypted Data blob storage and retrieval API with payments for storage handled by GNU Taler payments.
@@ -136,11 +143,8 @@ Overview
* **Consumers**: ``libeufin-cli``, (future) LibEuFin Web UI
-.. rubric:: EBICS
+.. rubric:: EBICS
* **Summary**: Allows businesses/banks/consumers to exchange data with a bank's core banking system.
* **Consumers**: LibEuFin Nexus
* **Providers**: libeufin-bank, Banks
-
-
-
diff --git a/core/index-bank-apis.rst b/core/index-bank-apis.rst
@@ -31,7 +31,7 @@ Bank RESTful APIs
api-bank-wire
api-bank-revenue
api-bank-integration
-
+
.. toctree::
:hidden:
diff --git a/design-documents/038-demobanks-protocol-suppliers.rst b/design-documents/038-demobanks-protocol-suppliers.rst
@@ -1,5 +1,5 @@
-DD 38: Demobanks protocol suppliers
-####################################
+XX 38: Demobanks protocol suppliers
+###################################
Summary
=======
@@ -101,7 +101,7 @@ Static X-LIBEUFIN-BANK with dynamic demobank
The ``x-libeufin-bank`` protocol supplier is reachable under
``/demobanks/{demobankName}/access-api/``. As the path suggests,
-it offers banking operations via the :doc:`Libeufin Bank API </core/api-libeufin-bank>`.
+it offers banking operations via the :doc:`Core Bank API </core/api-corebank>`.
It is static in the sense that it's not possible to assign a name
to one particular x-libeufin-bank protocol supplier. On the other
hand, the demobank is dynamic because can be specified along the path
diff --git a/libeufin/local-currencies-tutorial.rst b/libeufin/local-currencies-tutorial.rst
@@ -9,7 +9,7 @@ into fiat (a.k.a. cashing out).
The banking capabilities are offered by a LibEuFin service
called *Sandbox*. In particular, the tutorial relies on the
-:ref:`Libeufin Bank API <libeufin-bank-api>`. More information about libEufin
+:ref:`Core Bank API <corebank-api>`. More information about libEufin
can be found in the :doc:`How-To page </libeufin/nexus-tutorial>`.
The following sections show how to install and launch Sandbox
@@ -221,7 +221,7 @@ by the merchant. The two values will be checked by the bank along
this request, to make sure that both parties agree.
.. note::
-
+
The current version has a fixed **0.95** conversion rate for cashing
out. Future version will make this value configurable.
@@ -297,10 +297,10 @@ it, as the administrator, with the following command
.. _delete-account:
.. code-block:: console
-
+
export LIBEUFIN_SANDBOX_USERNAME=admin
export LIBEUFIN_SANDBOX_PASSWORD=secret
-
+
libeufin-cli \
sandbox demobank \
circuit-delete-account --username circuit-shop
@@ -353,9 +353,9 @@ error like the following:
Every Circuit API endpoint is addressed by a CLI subcommand
whose name starts with ``circuit-``. The following command
shows them.
-
+
.. code-block:: console
-
+
libeufin-cli sandbox demobank | grep circuit
.. _email-sms-setup:
diff --git a/libeufin/nexus-tutorial.rst b/libeufin/nexus-tutorial.rst
@@ -438,7 +438,7 @@ The responsible options are
For more information on the available commands, use the built-in ``--help`` flag.
The full functionality of the sandbox is available via
-the :ref:`Libeufin Bank API <libeufin-bank-api>`.
+the :ref:`Core Bank API <corebank-api>`.
Connect Nexus with the bank.
============================
