commit 775e8ff5f8c1f3e40954d52887c62ed0a27b17b7
parent aa5f2029ade115a48be770d594a224f4d1e3a776
Author: Antoine A <>
Date: Wed, 29 Jul 2026 11:05:23 +0200
add taler-wise adapter man pages
Diffstat:
7 files changed, 261 insertions(+), 3 deletions(-)
diff --git a/conf.py b/conf.py
@@ -1104,6 +1104,20 @@ man_pages = [
5,
),
(
+ "manpages/taler-wise.1",
+ "taler-wise",
+ "implementation of Wise Taler adapter",
+ "GNU Taler contributors",
+ 1,
+ ),
+ (
+ "manpages/taler-wise.conf.5",
+ "taler-wise.conf",
+ "Wise adapter configuration file",
+ "GNU Taler contributors",
+ 5,
+ ),
+ (
"manpages/taler-apns-relay.1",
"taler-apns-relay",
"implementation of Taler APNs relay",
diff --git a/core/api-overview.rst b/core/api-overview.rst
@@ -78,7 +78,7 @@ Overview
* **Summary**: Allows the Taler Exchange to query incoming transactions and initiate payments with a protocol that abstracts away details of the underlying banking system.
-* **Providers**: Taler fakebank, LibEuFin Nexus, Cyclos adapter, Depolymerization adapters
+* **Providers**: Taler fakebank, LibEuFin Nexus, Cyclos adapter, Wise adapter, Depolymerization adapters
* **Consumers**: GNU Taler Exchange, Wire Auditor
@@ -88,7 +88,7 @@ Overview
* **Summary**: Allows Taler clients to prepare wire transfers, enabling recurring wire transfers and optimized transfer flow.
-* **Providers**: LibEuFin Nexus, Cyclos adapter, Depolymerization adapters.
+* **Providers**: LibEuFin Nexus, Cyclos adapter, Wise adapter, Depolymerization adapters.
* **Consumers**: Taler Wallet
diff --git a/developer/taler-developer-manual.rst b/developer/taler-developer-manual.rst
@@ -46,6 +46,8 @@ overview:
* taler-cyclos: implementation of the "bank" API using the Cyclos API. Allows an exchange to interact with a Cyclos network.
+* taler-wise: implementation of the "bank" API using the Wise API. Allows an exchange to interact with Wise.
+
* depolymerization: implementation of the "bank" API on top of
blockchains, specifically Bitcoin and Ethereum. Allows an exchange
to interact with crypto-currencies.
diff --git a/index.rst b/index.rst
@@ -79,6 +79,7 @@ and overall usage of the different Taler components in text and video formats.
libeufin/index
taler-magnet-bank-manual
taler-cyclos-manual
+ taler-wise-manual
depolymerization/index
.. toctree::
diff --git a/manpages/taler-cyclos.1.rst b/manpages/taler-cyclos.1.rst
@@ -84,7 +84,7 @@ Its options are as follows:
worker
------
-This subcommand initiate transaction throught the Cyclos API and sync the the bank account history.
+This subcommand initiate transaction throught the Cyclos API and sync the bank account history.
If ACCOUNT_TYPE is ``exchange``, incoming payments with an invalid Taler subject are bounced.
diff --git a/manpages/taler-wise.1.rst b/manpages/taler-wise.1.rst
@@ -0,0 +1,126 @@
+taler-wise(1)
+###############
+
+.. only:: html
+
+ Name
+ ====
+
+ **taler-wise** - Wise Taler adapter.
+
+
+Synopsis
+========
+
+**taler-wise**
+[**-h** | **--help**]
+[**--version**]
+COMMAND [ARGS...]
+
+Subcommands: **dbinit**, **setup**,
+**serve**, **worker**, **config**
+
+
+Description
+===========
+
+**taler-wise** is a Taler adapter for the Wise API.
+
+Its options are as follows:
+
+**-h** \| **--help**
+ Print short help on options.
+
+**--version**
+ Print version information.
+
+The interaction model is as follows:
+
+- Configure the database with commands ``dbinit``.
+
+- Check API access with commands ``setup``.
+
+- After a successful setup, the subcommands ``worker`` can be run to both send payments and sync the bank account history.
+
+- Start the HTTP server with command ``serve``.
+ Let this run in a shell, writing logs to stderr.
+
+The following sections describe each command in detail.
+
+dbinit
+------
+
+This command defines the database schema for taler-wise. It is mandatory to run this command before invoking the ``setup`` or ``serve`` commands.
+
+Its options are as follows:
+
+**-c** \| **--config** *config_file*
+ Specifies the configuration file.
+**-L** \| **--log** *LOGLEVEL*
+ Configure logging to use LOGLEVEL.
+**-r** \| **--reset**
+ Reset database (DANGEROUS: All existing data is lost)
+**-h** \| **--help**
+ Print short help on options.
+
+setup
+-----
+
+This command establishes a working API connection. It verifies that the current configuration is valid and that the bank account has sufficient rights to function as an exchange.
+
+It is mandatory to run this command before invoking the ``worker`` command.
+
+Its options are as follows:
+
+**-c** \| **--config** *config_file*
+ Specifies the configuration file.
+**-L** \| **--log** *LOGLEVEL*
+ Configure logging to use LOGLEVEL.
+**-r** \| **--reset**
+ Reset connection info and overwrite keys file
+**-h** \| **--help**
+ Print short help on options.
+
+worker
+------
+
+This subcommand initiate transaction throught the Wise API and sync the balances account history.
+
+Its options are as follows:
+
+**-c** \| **--config** *config_file*
+ Specifies the configuration file.
+**-L** \| **--log** *LOGLEVEL*
+ Configure logging to use LOGLEVEL.
+**--transient**
+ Execute once and return.
+**-h** \| **--help**
+ Print short help on options.
+
+serve
+-----
+
+This command starts the HTTP server.
+
+Its options are as follows:
+
+**-c** \| **--config** *config_file*
+ Specifies the configuration file.
+**-L** \| **--log** *LOGLEVEL*
+ Configure logging to use LOGLEVEL.
+**--check**
+ Check whether an API is in use (if it's useful to start the HTTP server). Exit with 0 if at least one API is enabled, otherwise 1.
+**-h** \| **--help**
+ Print short help on options.
+
+.. include:: ../frags/common-config-cli.rst
+
+SEE ALSO
+========
+
+taler-wise.conf(5)
+
+Bugs
+====
+
+Report bugs by using https://bugs.taler.net or by sending electronic mail to <taler@gnu.org>.
diff --git a/manpages/taler-wise.conf.5.rst b/manpages/taler-wise.conf.5.rst
@@ -0,0 +1,114 @@
+taler-wise.conf(5)
+####################
+
+.. only:: html
+
+ Name
+ ====
+
+ **taler-wise.conf** - Wise Taler adapter configuration file
+
+
+Description
+===========
+
+.. include:: ../frags/common-conf-syntax.rst
+
+Files containing default values for many of the options described below
+are installed under ``$TALER_WISE_PREFIX/share/taler-wise/config.d/``.
+The configuration file given with **-c** to Taler binaries
+overrides these defaults.
+
+A configuration file may include another, by using the ``@INLINE@`` directive,
+for example, in ``main.conf``, you could write ``@INLINE@ sub.conf`` to
+include the entirety of ``sub.conf`` at that point in ``main.conf``.
+
+
+ADAPTER OPTIONS
+---------------
+
+The following options are from the “[wise]” section.
+
+NAME
+ Legal entity that is associated with the Cyclos account.
+
+WORKER OPTIONS
+--------------
+
+The following options are from the “[wise-worker]” section.
+
+FREQUENCY
+ How often should worker run when no notification is received
+
+TOKEN
+ Account token
+
+ACCOUNT_TYPE
+ Specify the account type and therefore the indexing behavior. This can either can be ``normal`` or ``exchange``. Exchange accounts bounce invalid incoming Taler transactions.
+
+BALANCE OPTIONS
+---------------
+
+The following options are from the “[wise-balance*]” section.
+
+ID
+ Balance Wise ID
+
+CURRENCY
+ Balance currency
+
+PAYTO_TYPE
+ Balance account type, this can only be ``iban``
+
+IBAN
+ Balance IBAN, for ``iban`` payto type
+
+BIC
+ Balance BIC, for ``iban`` payto type
+
+
+HTTP SERVER OPTIONS
+-------------------
+
+The following configuration value(s) belong to the “[wise-httpd]” section.
+
+.. include:: frags/common-serve-options.rst
+
+HTTP WIRE GATEWAY API OPTIONS
+-----------------------------
+
+The following configuration value(s) belong to the “[wise-httpd-wire-gateway-api]” section.
+
+ENABLED
+ Whether to serve the Wire Gateway API.
+
+.. include:: frags/common-api-options.rst
+
+HTTP REVENUE API OPTIONS
+------------------------
+
+The following configuration value(s) belong to the “[wise-httpd-revenue-api]” section.
+
+ENABLED
+ Whether to serve the Revenue API.
+
+.. include:: frags/common-api-options.rst
+
+DATABASE OPTIONS
+----------------
+
+Setting the database belongs to the “[wisedb-postgres]” section and the following value.
+
+.. include:: frags/common-db-options.rst
+
+
+SEE ALSO
+========
+
+taler-wise(1)
+
+BUGS
+====
+
+Report bugs by using https://bugs.taler.net/ or by sending electronic
+mail to <taler@gnu.org>.
+\ No newline at end of file
