taler-docs

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

commit aa56e9a67de099924b35f4f92c6f693b520662be
parent 9581208ee1bcf0e88e369057865a4cf38a8eb9b1
Author: Florian Dold <dold@taler.net>
Date:   Tue, 10 Nov 2026 18:32:01 +0100

wallet-core docs: normalize operation description indentation

Diffstat:
Mcore/wallet-core/bank-accounts/add-bank-account.rst | 32++++++++++++++++----------------
Mcore/wallet-core/bank-accounts/forget-bank-account.rst | 12++++++------
Mcore/wallet-core/bank-accounts/get-bank-account-by-id.rst | 8++++----
Mcore/wallet-core/bank-accounts/list-bank-accounts.rst | 12++++++------
Mcore/wallet-core/contacts/add-contact.rst | 10+++++-----
Mcore/wallet-core/contacts/delete-contact.rst | 16++++++++--------
Mcore/wallet-core/contacts/get-contacts.rst | 4++--
Mcore/wallet-core/database/clear-db.rst | 12++++++------
Mcore/wallet-core/database/export-db-to-file.rst | 14+++++++-------
Mcore/wallet-core/database/export-db.rst | 4++--
Mcore/wallet-core/database/import-db-from-file.rst | 22+++++++++++-----------
Mcore/wallet-core/database/import-db.rst | 36++++++++++++++++++------------------
Mcore/wallet-core/database/migrate-database.rst | 30+++++++++++++++---------------
Mcore/wallet-core/database/recycle.rst | 8++++----
Mcore/wallet-core/diagnostics/get-active-tasks.rst | 14+++++++-------
Mcore/wallet-core/diagnostics/get-diagnostics.rst | 26+++++++++++++-------------
Mcore/wallet-core/donau/get-donau-statements.rst | 22+++++++++++-----------
Mcore/wallet-core/donau/get-donau.rst | 8++++----
Mcore/wallet-core/donau/set-donau.rst | 18+++++++++---------
Mcore/wallet-core/global-currency/add-global-currency-auditor.rst | 16++++++++--------
Mcore/wallet-core/global-currency/add-global-currency-exchange.rst | 22+++++++++++-----------
Mcore/wallet-core/global-currency/get-currency-specification.rst | 16++++++++--------
Mcore/wallet-core/global-currency/list-global-currency-auditors.rst | 6+++---
Mcore/wallet-core/global-currency/list-global-currency-exchanges.rst | 6+++---
Mcore/wallet-core/global-currency/remove-global-currency-auditor.rst | 14+++++++-------
Mcore/wallet-core/global-currency/remove-global-currency-exchange.rst | 16++++++++--------
Mcore/wallet-core/init/get-version.rst | 10+++++-----
Mcore/wallet-core/init/init-wallet.rst | 38+++++++++++++++++++-------------------
Mcore/wallet-core/init/set-wallet-run-config.rst | 18+++++++++---------
Mcore/wallet-core/init/shutdown.rst | 16++++++++--------
Mcore/wallet-core/mailbox/add-mailbox-message.rst | 8++++----
Mcore/wallet-core/mailbox/delete-mailbox-message.rst | 18+++++++++---------
Mcore/wallet-core/mailbox/get-mailbox-message.rst | 10+++++-----
Mcore/wallet-core/mailbox/get-mailbox.rst | 8++++----
Mcore/wallet-core/mailbox/initialize-mailbox.rst | 34+++++++++++++++++-----------------
Mcore/wallet-core/mailbox/refresh-mailbox.rst | 36++++++++++++++++++------------------
Mcore/wallet-core/mailbox/send-taler-uri-mailbox-message.rst | 14+++++++-------
Mcore/wallet-core/payments/check-pay-for-template.rst | 54+++++++++++++++++++++++++++---------------------------
Mcore/wallet-core/payments/confirm-pay.rst | 40++++++++++++++++++++--------------------
Mcore/wallet-core/payments/get-choices-for-payment.rst | 24++++++++++++------------
Mcore/wallet-core/payments/get-paivana-cookie.rst | 28++++++++++++++--------------
Mcore/wallet-core/payments/prepare-pay-for-paivana.rst | 22+++++++++++-----------
Mcore/wallet-core/payments/prepare-pay-for-template-v2.rst | 14+++++++-------
Mcore/wallet-core/payments/prepare-pay-for-uri-v2.rst | 34+++++++++++++++++-----------------
Mcore/wallet-core/payments/reclaim-payment.rst | 14+++++++-------
Mcore/wallet-core/payments/start-refund-query-for-uri.rst | 14+++++++-------
Mcore/wallet-core/payments/start-refund-query.rst | 8++++----
Mcore/wallet-core/payments/unclaim-payment.rst | 20++++++++++----------
Mcore/wallet-core/taldir/complete-register-alias.rst | 26+++++++++++++-------------
Mcore/wallet-core/taldir/lookup-alias.rst | 16++++++++--------
Mcore/wallet-core/taldir/register-alias.rst | 18+++++++++---------
Mcore/wallet-core/testing/apply-dev-experiment.rst | 8++++----
Mcore/wallet-core/testing/dump-coins.rst | 4++--
Mcore/wallet-core/testing/force-refresh.rst | 16++++++++--------
Mcore/wallet-core/testing/run-integration-test-v2.rst | 8++++----
Mcore/wallet-core/testing/run-integration-test.rst | 8++++----
Mcore/wallet-core/testing/set-coin-suspended.rst | 18+++++++++---------
Mcore/wallet-core/testing/test-crypto.rst | 4++--
Mcore/wallet-core/testing/test-pay.rst | 8++++----
Mcore/wallet-core/testing/testing-check-coins.rst | 8++++----
Mcore/wallet-core/testing/testing-corrupt-withdrawal-coin-sel.rst | 16++++++++--------
Mcore/wallet-core/testing/testing-get-db-stats.rst | 4++--
Mcore/wallet-core/testing/testing-get-denom-stats.rst | 4++--
Mcore/wallet-core/testing/testing-get-flight-records.rst | 6+++---
Mcore/wallet-core/testing/testing-get-performance-stats.rst | 4++--
Mcore/wallet-core/testing/testing-get-reserve-history.rst | 8++++----
Mcore/wallet-core/testing/testing-get-sample-transactions.rst | 4++--
Mcore/wallet-core/testing/testing-ping.rst | 4++--
Mcore/wallet-core/testing/testing-plan-migrate-exchange-base-url.rst | 10+++++-----
Mcore/wallet-core/testing/testing-recover-coins.rst | 10+++++-----
Mcore/wallet-core/testing/testing-reset-all-retries.rst | 8++++----
Mcore/wallet-core/testing/testing-run-fixup.rst | 6+++---
Mcore/wallet-core/testing/testing-set-timetravel.rst | 8++++----
Mcore/wallet-core/testing/testing-wait-balance.rst | 4++--
Mcore/wallet-core/testing/testing-wait-exchange-ready.rst | 8++++----
Mcore/wallet-core/testing/testing-wait-exchange-state.rst | 4++--
Mcore/wallet-core/testing/testing-wait-refreshes-final.rst | 4++--
Mcore/wallet-core/testing/testing-wait-tasks-done.rst | 4++--
Mcore/wallet-core/testing/testing-wait-transaction-state.rst | 4++--
Mcore/wallet-core/testing/testing-wait-transactions-final.rst | 4++--
Mcore/wallet-core/testing/testing-wait-wallet-kyc.rst | 4++--
Mcore/wallet-core/testing/withdraw-test-balance.rst | 20++++++++++----------
Mcore/wallet-core/testing/withdraw-testkudos.rst | 8++++----
Mcore/wallet-core/tokens/delete-discount.rst | 14+++++++-------
Mcore/wallet-core/tokens/delete-subscription.rst | 14+++++++-------
Mcore/wallet-core/tokens/list-discounts.rst | 6+++---
Mcore/wallet-core/tokens/list-subscriptions.rst | 6+++---
Mcore/wallet-core/transactions/abort-transaction.rst | 28++++++++++++++--------------
Mcore/wallet-core/transactions/delete-transaction.rst | 18+++++++++---------
Mcore/wallet-core/transactions/fail-transaction.rst | 30+++++++++++++++---------------
Mcore/wallet-core/transactions/get-transaction-by-id.rst | 22+++++++++++-----------
Mcore/wallet-core/transactions/get-transactions-v2.rst | 46+++++++++++++++++++++++-----------------------
Mcore/wallet-core/transactions/get-transactions.rst | 26+++++++++++++-------------
Mcore/wallet-core/transactions/list-associated-refreshes.rst | 8++++----
Mcore/wallet-core/transactions/resolve-transaction-reference.rst | 38+++++++++++++++++++-------------------
Mcore/wallet-core/transactions/resume-transaction.rst | 16++++++++--------
Mcore/wallet-core/transactions/retry-transaction.rst | 20++++++++++----------
Mcore/wallet-core/transactions/suspend-transaction.rst | 14+++++++-------
Mcore/wallet-core/transactions/wait-transaction-state.rst | 74+++++++++++++++++++++++++++++++++++++-------------------------------------
Mcore/wallet-core/validation/canonicalize-base-url.rst | 12++++++------
Mcore/wallet-core/validation/convert-iban-account-field-to-payto.rst | 18+++++++++---------
Mcore/wallet-core/validation/convert-iban-payto-to-account-field.rst | 16++++++++--------
Mcore/wallet-core/validation/get-banking-choices-for-payto.rst | 18+++++++++---------
Mcore/wallet-core/validation/get-qr-codes-for-payto.rst | 12++++++------
Mcore/wallet-core/validation/validate-iban.rst | 4++--
105 files changed, 822 insertions(+), 822 deletions(-)

diff --git a/core/wallet-core/bank-accounts/add-bank-account.rst b/core/wallet-core/bank-accounts/add-bank-account.rst @@ -4,35 +4,35 @@ **Request:** - The request must be an `AddBankAccountRequest` object. + The request must be an `AddBankAccountRequest` object. **Response:** - On success, the result is an `AddBankAccountResponse` object. + On success, the result is an `AddBankAccountResponse` object. **Side effects:** - Adds the bank account to the wallet's database, or updates the - existing account with the same ``paytoUri``. A - ``bank-account-change`` notification is emitted. + Adds the bank account to the wallet's database, or updates the + existing account with the same ``paytoUri``. A + ``bank-account-change`` notification is emitted. **Expected errors:** - The caller can handle the following errors inline: - ``GENERIC_PAYTO_URI_MALFORMED``, ``WALLET_BANK_ACCOUNT_NOT_FOUND``. + The caller can handle the following errors inline: + ``GENERIC_PAYTO_URI_MALFORMED``, ``WALLET_BANK_ACCOUNT_NOT_FOUND``. **Details:** - If an account with the same ``paytoUri`` is already known, it is - updated (the supported currencies are merged) and its identifier - is returned. When ``replaceBankAccountId`` is specified, the - account with that identifier is replaced and keeps its - identifier; the request fails with - ``WALLET_BANK_ACCOUNT_NOT_FOUND`` when no such account exists. + If an account with the same ``paytoUri`` is already known, it is + updated (the supported currencies are merged) and its identifier + is returned. When ``replaceBankAccountId`` is specified, the + account with that identifier is replaced and keeps its + identifier; the request fails with + ``WALLET_BANK_ACCOUNT_NOT_FOUND`` when no such account exists. - In all cases the stored account is rewritten with the values from - the request, so updating or replacing an account resets its - ``kycCompleted`` flag to ``false``. + In all cases the stored account is rewritten with the values from + the request, so updating or replacing an account resets its + ``kycCompleted`` flag to ``false``. .. ts:def:: AddBankAccountRequest diff --git a/core/wallet-core/bank-accounts/forget-bank-account.rst b/core/wallet-core/bank-accounts/forget-bank-account.rst @@ -4,21 +4,21 @@ **Request:** - The request must be a `ForgetBankAccountRequest` object. + The request must be a `ForgetBankAccountRequest` object. **Response:** - On success, the result is an empty object (`EmptyObject`). + On success, the result is an empty object (`EmptyObject`). **Side effects:** - Removes the bank account from the wallet's database. A - ``bank-account-change`` notification is emitted. + Removes the bank account from the wallet's database. A + ``bank-account-change`` notification is emitted. **Expected errors:** - The caller can handle the following errors inline: - ``WALLET_BANK_ACCOUNT_NOT_FOUND``. + The caller can handle the following errors inline: + ``WALLET_BANK_ACCOUNT_NOT_FOUND``. .. ts:def:: ForgetBankAccountRequest diff --git a/core/wallet-core/bank-accounts/get-bank-account-by-id.rst b/core/wallet-core/bank-accounts/get-bank-account-by-id.rst @@ -5,16 +5,16 @@ **Request:** - The request must be a `GetBankAccountByIdRequest` object. + The request must be a `GetBankAccountByIdRequest` object. **Response:** - On success, the result is a `GetBankAccountByIdResponse` object. + On success, the result is a `GetBankAccountByIdResponse` object. **Expected errors:** - The caller can handle the following errors inline: - ``WALLET_BANK_ACCOUNT_NOT_FOUND``. + The caller can handle the following errors inline: + ``WALLET_BANK_ACCOUNT_NOT_FOUND``. .. ts:def:: GetBankAccountByIdRequest diff --git a/core/wallet-core/bank-accounts/list-bank-accounts.rst b/core/wallet-core/bank-accounts/list-bank-accounts.rst @@ -5,18 +5,18 @@ **Request:** - The request must be a `ListBankAccountsRequest` object. + The request must be a `ListBankAccountsRequest` object. **Response:** - On success, the result is a `ListBankAccountsResponse` object. + On success, the result is a `ListBankAccountsResponse` object. **Details:** - When ``currency`` is specified, only accounts that support the - currency are returned; accounts whose supported currencies are - unknown are always included. Stored accounts whose ``paytoUri`` - can no longer be parsed are silently skipped. + When ``currency`` is specified, only accounts that support the + currency are returned; accounts whose supported currencies are + unknown are always included. Stored accounts whose ``paytoUri`` + can no longer be parsed are silently skipped. .. ts:def:: ListBankAccountsRequest diff --git a/core/wallet-core/contacts/add-contact.rst b/core/wallet-core/contacts/add-contact.rst @@ -6,17 +6,17 @@ **Request:** - The request arguments are an `AddContactRequest` object. + The request arguments are an `AddContactRequest` object. **Response:** - On success, the result is an empty object. + On success, the result is an empty object. **Side effects:** - Adds or updates the contact in the wallet's contact list. After - the contact list has changed, wallet-core emits a - ``contact-added`` notification. + Adds or updates the contact in the wallet's contact list. After + the contact list has changed, wallet-core emits a + ``contact-added`` notification. .. ts:def:: AddContactRequest diff --git a/core/wallet-core/contacts/delete-contact.rst b/core/wallet-core/contacts/delete-contact.rst @@ -4,23 +4,23 @@ **Request:** - The request arguments are a `DeleteContactRequest` object. + The request arguments are a `DeleteContactRequest` object. **Response:** - On success, the result is an empty object. + On success, the result is an empty object. **Side effects:** - Deletes the contact from the wallet's contact list and emits a - ``contact-deleted`` notification. + Deletes the contact from the wallet's contact list and emits a + ``contact-deleted`` notification. **Details:** - Only the ``alias`` and ``aliasType`` fields of the given contact - are used to identify the contact to delete; the remaining fields - are ignored. Deleting a contact that does not exist is not an - error. + Only the ``alias`` and ``aliasType`` fields of the given contact + are used to identify the contact to delete; the remaining fields + are ignored. Deleting a contact that does not exist is not an + error. .. ts:def:: DeleteContactRequest diff --git a/core/wallet-core/contacts/get-contacts.rst b/core/wallet-core/contacts/get-contacts.rst @@ -5,11 +5,11 @@ **Request:** - This operation takes no arguments (an empty object). + This operation takes no arguments (an empty object). **Response:** - On success, the result is a `ContactListResponse` object. + On success, the result is a `ContactListResponse` object. .. ts:def:: ContactListResponse diff --git a/core/wallet-core/database/clear-db.rst b/core/wallet-core/database/clear-db.rst @@ -4,18 +4,18 @@ **Request:** - This operation takes no arguments (an empty object). + This operation takes no arguments (an empty object). **Response:** - On success, the result is an empty object. + On success, the result is an empty object. **Side effects:** - Irreversibly deletes the entire wallet database. + Irreversibly deletes the entire wallet database. **Details:** - In addition to the database contents, all in-memory caches and the - recorded flight records are cleared, and the background task - scheduler is reloaded. + In addition to the database contents, all in-memory caches and the + recorded flight records are cleared, and the background task + scheduler is reloaded. diff --git a/core/wallet-core/database/export-db-to-file.rst b/core/wallet-core/database/export-db-to-file.rst @@ -5,25 +5,25 @@ **Request:** - The request arguments must be an `ExportDbToFileRequest` object. + The request arguments must be an `ExportDbToFileRequest` object. **Response:** - On success, the result is an `ExportDbToFileResponse` object. + On success, the result is an `ExportDbToFileResponse` object. **Side effects:** - Writes the database dump to a new file on the host filesystem. + Writes the database dump to a new file on the host filesystem. **Expected errors:** - The caller can handle the following errors inline: - ``WALLET_DB_BACKEND_UNSUPPORTED``. + The caller can handle the following errors inline: + ``WALLET_DB_BACKEND_UNSUPPORTED``. **Details:** - The request fails with ``WALLET_DB_BACKEND_UNSUPPORTED`` if the - active database backend cannot export the database to a file. + The request fails with ``WALLET_DB_BACKEND_UNSUPPORTED`` if the + active database backend cannot export the database to a file. .. ts:def:: ExportDbToFileRequest diff --git a/core/wallet-core/database/export-db.rst b/core/wallet-core/database/export-db.rst @@ -5,8 +5,8 @@ **Request:** - This operation takes no arguments (an empty object). + This operation takes no arguments (an empty object). **Response:** - On success, the result is an unspecified JSON value. + On success, the result is an unspecified JSON value. diff --git a/core/wallet-core/database/import-db-from-file.rst b/core/wallet-core/database/import-db-from-file.rst @@ -5,29 +5,29 @@ **Request:** - The request arguments must be an `ImportDbFromFileRequest` object. + The request arguments must be an `ImportDbFromFileRequest` object. **Response:** - On success, the result is an empty object. + On success, the result is an empty object. **Side effects:** - Replaces the entire contents of the wallet database with the dump - read from the given file. + Replaces the entire contents of the wallet database with the dump + read from the given file. **Expected errors:** - The caller can handle the following errors inline: - ``WALLET_DB_BACKEND_UNSUPPORTED``, ``WALLET_CORE_API_BAD_REQUEST``, - ``WALLET_CORE_REQUEST_CANCELLED``. + The caller can handle the following errors inline: + ``WALLET_DB_BACKEND_UNSUPPORTED``, ``WALLET_CORE_API_BAD_REQUEST``, + ``WALLET_CORE_REQUEST_CANCELLED``. **Details:** - The ``path`` must end in ``.json`` or ``.sqlite3``; other files - are rejected with ``WALLET_CORE_API_BAD_REQUEST``, as is a file - that cannot be read. The ``progressToken`` behaves as for - :ts:op:`importDb`. + The ``path`` must end in ``.json`` or ``.sqlite3``; other files + are rejected with ``WALLET_CORE_API_BAD_REQUEST``, as is a file + that cannot be read. The ``progressToken`` behaves as for + :ts:op:`importDb`. .. ts:def:: ImportDbFromFileRequest diff --git a/core/wallet-core/database/import-db.rst b/core/wallet-core/database/import-db.rst @@ -5,36 +5,36 @@ **Request:** - The request arguments must be an `ImportDbRequest` object. + The request arguments must be an `ImportDbRequest` object. **Response:** - On success, the result is an empty object. + On success, the result is an empty object. **Side effects:** - Replaces the entire contents of the wallet database with the - imported dump. + Replaces the entire contents of the wallet database with the + imported dump. **Expected errors:** - The caller can handle the following errors inline: - ``WALLET_DB_BACKEND_UNSUPPORTED``, ``WALLET_CORE_API_BAD_REQUEST``, - ``WALLET_CORE_REQUEST_CANCELLED``. + The caller can handle the following errors inline: + ``WALLET_DB_BACKEND_UNSUPPORTED``, ``WALLET_CORE_API_BAD_REQUEST``, + ``WALLET_CORE_REQUEST_CANCELLED``. **Details:** - The format of ``dump`` (JSON or SQLite) is detected automatically. - A ``dump`` that does not look like a valid wallet database dump is - rejected with ``WALLET_CORE_API_BAD_REQUEST``; if the active - database backend cannot import the dump's format, the request - fails with ``WALLET_DB_BACKEND_UNSUPPORTED``. When - ``progressToken`` is set, progress is reported via notifications - and the import can be cancelled with :ts:op:`cancelProgressToken`; - a cancelled import fails with ``WALLET_CORE_REQUEST_CANCELLED``. - After a successful import, all in-memory caches (exchange, - denomination and refresh-cost data) are cleared, and the imported - records are used to recompute the derived transaction view. + The format of ``dump`` (JSON or SQLite) is detected automatically. + A ``dump`` that does not look like a valid wallet database dump is + rejected with ``WALLET_CORE_API_BAD_REQUEST``; if the active + database backend cannot import the dump's format, the request + fails with ``WALLET_DB_BACKEND_UNSUPPORTED``. When + ``progressToken`` is set, progress is reported via notifications + and the import can be cancelled with :ts:op:`cancelProgressToken`; + a cancelled import fails with ``WALLET_CORE_REQUEST_CANCELLED``. + After a successful import, all in-memory caches (exchange, + denomination and refresh-cost data) are cleared, and the imported + records are used to recompute the derived transaction view. .. ts:def:: ImportDbRequest diff --git a/core/wallet-core/database/migrate-database.rst b/core/wallet-core/database/migrate-database.rst @@ -6,33 +6,33 @@ **Request:** - The request arguments must be a `MigrateDatabaseRequest` object. + The request arguments must be a `MigrateDatabaseRequest` object. **Response:** - On success, the result is a `MigrateDatabaseResponse` object. + On success, the result is a `MigrateDatabaseResponse` object. **Side effects:** - Converts the wallet database to the native SQLite schema. The - migration can be long-running; progress is reported via - notifications when ``progressToken`` is set. + Converts the wallet database to the native SQLite schema. The + migration can be long-running; progress is reported via + notifications when ``progressToken`` is set. **Expected errors:** - The caller can handle the following errors inline: - ``WALLET_DB_BACKEND_UNSUPPORTED``, ``WALLET_DB_UNAVAILABLE``, - ``WALLET_CORE_REQUEST_CANCELLED``. + The caller can handle the following errors inline: + ``WALLET_DB_BACKEND_UNSUPPORTED``, ``WALLET_DB_UNAVAILABLE``, + ``WALLET_CORE_REQUEST_CANCELLED``. **Details:** - When the wallet already uses the native SQLite schema, the request - succeeds with ``migrated`` set to false. The optional - ``progressToken`` correlates progress notifications and allows - cancellation via :ts:op:`cancelProgressToken`. If the migration - itself fails, the request fails with ``WALLET_DB_UNAVAILABLE`` and - the existing (IndexedDB) database remains active; a cancelled - migration fails with ``WALLET_CORE_REQUEST_CANCELLED``. + When the wallet already uses the native SQLite schema, the request + succeeds with ``migrated`` set to false. The optional + ``progressToken`` correlates progress notifications and allows + cancellation via :ts:op:`cancelProgressToken`. If the migration + itself fails, the request fails with ``WALLET_DB_UNAVAILABLE`` and + the existing (IndexedDB) database remains active; a cancelled + migration fails with ``WALLET_CORE_REQUEST_CANCELLED``. .. ts:def:: MigrateDatabaseRequest diff --git a/core/wallet-core/database/recycle.rst b/core/wallet-core/database/recycle.rst @@ -7,13 +7,13 @@ **Request:** - This operation takes no arguments (an empty object). + This operation takes no arguments (an empty object). **Response:** - On success, the result is an empty object. + On success, the result is an empty object. **Side effects:** - None. The operation is declared but not implemented yet and - always fails with ``GENERIC_FEATURE_NOT_IMPLEMENTED``. + None. The operation is declared but not implemented yet and + always fails with ``GENERIC_FEATURE_NOT_IMPLEMENTED``. diff --git a/core/wallet-core/diagnostics/get-active-tasks.rst b/core/wallet-core/diagnostics/get-active-tasks.rst @@ -6,19 +6,19 @@ **Request:** - This operation takes no arguments (an empty object). + This operation takes no arguments (an empty object). **Response:** - On success, the result is a `GetActiveTasksResponse` object. + On success, the result is a `GetActiveTasksResponse` object. **Details:** - Tasks are wallet-core's background retry loops, for example for - pending withdrawals or payments. ``firstTry`` and ``nextTry`` - give the time of the first attempt and of the next scheduled - retry; ``lastError`` is the error of the most recent attempt, if - any. + Tasks are wallet-core's background retry loops, for example for + pending withdrawals or payments. ``firstTry`` and ``nextTry`` + give the time of the first attempt and of the next scheduled + retry; ``lastError`` is the error of the most recent attempt, if + any. .. ts:def:: GetActiveTasksResponse diff --git a/core/wallet-core/diagnostics/get-diagnostics.rst b/core/wallet-core/diagnostics/get-diagnostics.rst @@ -6,28 +6,28 @@ **Request:** - The request arguments must be a `GetDiagnosticsRequest` object. + The request arguments must be a `GetDiagnosticsRequest` object. **Response:** - On success, the result is a `GetDiagnosticsResponse`: the - diagnostics report serialized as a string. + On success, the result is a `GetDiagnosticsResponse`: the + diagnostics report serialized as a string. **Expected errors:** - The caller can handle the following errors inline: - ``WALLET_CORE_API_BAD_REQUEST``. + The caller can handle the following errors inline: + ``WALLET_CORE_API_BAD_REQUEST``. **Details:** - The report is privacy-scrubbed: transaction identifiers are - replaced by synthetic labels. It contains the wallet-core - version, the database backend with record counts, the known - exchanges, coins, bank accounts and the newest transactions (at - most ``transactionLimit`` of them). The - ``WALLET_CORE_API_BAD_REQUEST`` error is raised when - ``transactionLimit`` is not a non-negative safe integer smaller - than ``Number.MAX_SAFE_INTEGER``. + The report is privacy-scrubbed: transaction identifiers are + replaced by synthetic labels. It contains the wallet-core + version, the database backend with record counts, the known + exchanges, coins, bank accounts and the newest transactions (at + most ``transactionLimit`` of them). The + ``WALLET_CORE_API_BAD_REQUEST`` error is raised when + ``transactionLimit`` is not a non-negative safe integer smaller + than ``Number.MAX_SAFE_INTEGER``. .. ts:def:: GetDiagnosticsRequest diff --git a/core/wallet-core/donau/get-donau-statements.rst b/core/wallet-core/donau/get-donau-statements.rst @@ -6,26 +6,26 @@ **Request:** - The request arguments must be a `GetDonauStatementsRequest` - object. + The request arguments must be a `GetDonauStatementsRequest` + object. **Response:** - On success, the result is a `GetDonauStatementsResponse` object. + On success, the result is a `GetDonauStatementsResponse` object. **Side effects:** - Submits all pending donation receipts to the respective donation - authority over the network and marks them as submitted in the - wallet database, emitting a balance-change notification, before - the statements are fetched. + Submits all pending donation receipts to the respective donation + authority over the network and marks them as submitted in the + wallet database, emitting a balance-change notification, before + the statements are fetched. **Details:** - A statement is requested from every donation authority (or only - from the one named by ``donauBaseUrl``, if given) for each year - with submitted receipts; years for which the authority has not yet - issued a statement contribute no entry to the result. + A statement is requested from every donation authority (or only + from the one named by ``donauBaseUrl``, if given) for each year + with submitted receipts; years for which the authority has not yet + issued a statement contribute no entry to the result. .. ts:def:: GetDonauStatementsRequest diff --git a/core/wallet-core/donau/get-donau.rst b/core/wallet-core/donau/get-donau.rst @@ -5,13 +5,13 @@ **Request:** - This operation takes no arguments (an empty object). + This operation takes no arguments (an empty object). **Response:** - On success, the result is a `GetDonauResponse` object. The - ``currentDonauInfo`` field is undefined if no donation authority - has been configured. + On success, the result is a `GetDonauResponse` object. The + ``currentDonauInfo`` field is undefined if no donation authority + has been configured. .. ts:def:: GetDonauResponse diff --git a/core/wallet-core/donau/set-donau.rst b/core/wallet-core/donau/set-donau.rst @@ -4,24 +4,24 @@ **Request:** - The request arguments must be a `SetDonauRequest` object. + The request arguments must be a `SetDonauRequest` object. **Response:** - On success, the result is an empty object. + On success, the result is an empty object. **Side effects:** - Writes the donation authority configuration to the wallet - database, replacing any previously configured authority. + Writes the donation authority configuration to the wallet + database, replacing any previously configured authority. **Details:** - The taxpayer ID is stored together with a salted hash of it (as - defined in LSD0013) that is later used to submit and query - donation receipts. Repeating the request with an unchanged - ``donauBaseUrl`` and ``taxPayerId`` is idempotent: the existing - salt is kept. + The taxpayer ID is stored together with a salted hash of it (as + defined in LSD0013) that is later used to submit and query + donation receipts. Repeating the request with an unchanged + ``donauBaseUrl`` and ``taxPayerId`` is idempotent: the existing + salt is kept. .. ts:def:: SetDonauRequest diff --git a/core/wallet-core/global-currency/add-global-currency-auditor.rst b/core/wallet-core/global-currency/add-global-currency-auditor.rst @@ -4,23 +4,23 @@ **Request:** - The request must be an `AddGlobalCurrencyAuditorRequest` object. + The request must be an `AddGlobalCurrencyAuditorRequest` object. **Response:** - On success, the result is an empty object (`EmptyObject`). + On success, the result is an empty object (`EmptyObject`). **Side effects:** - Registers the auditor for the global currency in the wallet's - database. When the configuration changed, a ``balance-change`` - notification is emitted. + Registers the auditor for the global currency in the wallet's + database. When the configuration changed, a ``balance-change`` + notification is emitted. **Details:** - Adding an auditor that is already registered is a no-op. The - ``auditorBaseUrl`` must be a canonicalized base URL (see - :ts:op:`canonicalizeBaseUrl`). + Adding an auditor that is already registered is a no-op. The + ``auditorBaseUrl`` must be a canonicalized base URL (see + :ts:op:`canonicalizeBaseUrl`). .. ts:def:: AddGlobalCurrencyAuditorRequest diff --git a/core/wallet-core/global-currency/add-global-currency-exchange.rst b/core/wallet-core/global-currency/add-global-currency-exchange.rst @@ -4,26 +4,26 @@ **Request:** - The request must be an `AddGlobalCurrencyExchangeRequest` - object. + The request must be an `AddGlobalCurrencyExchangeRequest` + object. **Response:** - On success, the result is an empty object (`EmptyObject`). + On success, the result is an empty object (`EmptyObject`). **Side effects:** - Registers the exchange for the global currency in the wallet's - database. When the configuration changed, a ``balance-change`` - notification is emitted. + Registers the exchange for the global currency in the wallet's + database. When the configuration changed, a ``balance-change`` + notification is emitted. **Details:** - Adding an exchange that is already registered is a no-op. - Currency information already known under the exchange's own - scope is copied to the global scope. The ``exchangeBaseUrl`` - must be a canonicalized base URL (see - :ts:op:`canonicalizeBaseUrl`). + Adding an exchange that is already registered is a no-op. + Currency information already known under the exchange's own + scope is copied to the global scope. The ``exchangeBaseUrl`` + must be a canonicalized base URL (see + :ts:op:`canonicalizeBaseUrl`). .. ts:def:: AddGlobalCurrencyExchangeRequest diff --git a/core/wallet-core/global-currency/get-currency-specification.rst b/core/wallet-core/global-currency/get-currency-specification.rst @@ -6,20 +6,20 @@ **Request:** - The request must be a `GetCurrencySpecificationRequest` object. + The request must be a `GetCurrencySpecificationRequest` object. **Response:** - On success, the result is a `GetCurrencySpecificationResponse` - object. + On success, the result is a `GetCurrencySpecificationResponse` + object. **Details:** - The specification recorded for the given scope is returned. For - the demonstration currencies ``KUDOS`` and ``TESTKUDOS``, a - hard-coded specification is returned. When no specification is - known for the scope, a default with two fractional digits - derived from the currency name is returned. + The specification recorded for the given scope is returned. For + the demonstration currencies ``KUDOS`` and ``TESTKUDOS``, a + hard-coded specification is returned. When no specification is + known for the scope, a default with two fractional digits + derived from the currency name is returned. .. ts:def:: GetCurrencySpecificationRequest diff --git a/core/wallet-core/global-currency/list-global-currency-auditors.rst b/core/wallet-core/global-currency/list-global-currency-auditors.rst @@ -5,12 +5,12 @@ **Request:** - This operation takes no arguments (an empty object). + This operation takes no arguments (an empty object). **Response:** - On success, the result is a `ListGlobalCurrencyAuditorsResponse` - object. + On success, the result is a `ListGlobalCurrencyAuditorsResponse` + object. .. ts:def:: ListGlobalCurrencyAuditorsResponse diff --git a/core/wallet-core/global-currency/list-global-currency-exchanges.rst b/core/wallet-core/global-currency/list-global-currency-exchanges.rst @@ -5,12 +5,12 @@ **Request:** - This operation takes no arguments (an empty object). + This operation takes no arguments (an empty object). **Response:** - On success, the result is a - `ListGlobalCurrencyExchangesResponse` object. + On success, the result is a + `ListGlobalCurrencyExchangesResponse` object. .. ts:def:: ListGlobalCurrencyExchangesResponse diff --git a/core/wallet-core/global-currency/remove-global-currency-auditor.rst b/core/wallet-core/global-currency/remove-global-currency-auditor.rst @@ -4,22 +4,22 @@ **Request:** - The request must be a `RemoveGlobalCurrencyAuditorRequest` - object. + The request must be a `RemoveGlobalCurrencyAuditorRequest` + object. **Response:** - On success, the result is an empty object (`EmptyObject`). + On success, the result is an empty object (`EmptyObject`). **Side effects:** - Removes the registration from the wallet's database. When the - configuration changed, a ``balance-change`` notification is - emitted. + Removes the registration from the wallet's database. When the + configuration changed, a ``balance-change`` notification is + emitted. **Details:** - Removing an auditor that is not registered is a no-op. + Removing an auditor that is not registered is a no-op. .. ts:def:: RemoveGlobalCurrencyAuditorRequest diff --git a/core/wallet-core/global-currency/remove-global-currency-exchange.rst b/core/wallet-core/global-currency/remove-global-currency-exchange.rst @@ -4,23 +4,23 @@ **Request:** - The request must be a `RemoveGlobalCurrencyExchangeRequest` - object. + The request must be a `RemoveGlobalCurrencyExchangeRequest` + object. **Response:** - On success, the result is an empty object (`EmptyObject`). + On success, the result is an empty object (`EmptyObject`). **Side effects:** - Removes the registration from the wallet's database; removing - the last exchange of a currency also removes the global - currency information. When the configuration changed, a - ``balance-change`` notification is emitted. + Removes the registration from the wallet's database; removing + the last exchange of a currency also removes the global + currency information. When the configuration changed, a + ``balance-change`` notification is emitted. **Details:** - Removing an exchange that is not registered is a no-op. + Removing an exchange that is not registered is a no-op. .. ts:def:: RemoveGlobalCurrencyExchangeRequest diff --git a/core/wallet-core/init/get-version.rst b/core/wallet-core/init/get-version.rst @@ -6,17 +6,17 @@ **Request:** - This operation takes no arguments (an empty object). + This operation takes no arguments (an empty object). **Response:** - On success, the result is a `WalletCoreVersion` object. + On success, the result is a `WalletCoreVersion` object. **Details:** - The wallet must have been initialized first (see - :ts:op:`initWallet`); before initialization this operation fails - with ``WALLET_CORE_NOT_AVAILABLE``. + The wallet must have been initialized first (see + :ts:op:`initWallet`); before initialization this operation fails + with ``WALLET_CORE_NOT_AVAILABLE``. .. ts:def:: WalletCoreVersion diff --git a/core/wallet-core/init/init-wallet.rst b/core/wallet-core/init/init-wallet.rst @@ -6,35 +6,35 @@ **Request:** - The request must be an `InitRequest` object. + The request must be an `InitRequest` object. **Response:** - On success, the result is an `InitResponse` object. + On success, the result is an `InitResponse` object. **Side effects:** - Initializes the wallet: opens the wallet database (using the - native sqlite schema for a new, empty database when - ``config.features.useNativeDb`` is set, and migrating an existing - database to the native sqlite schema when - ``config.features.migrateNativeDb`` is set), installs the built-in - default exchanges (unless ``config.testing.skipDefaults`` is set), - applies ``config.logLevel`` as the global log level, runs internal - data migrations and — on the first initialization only — cleans up - failed and leftover claims and deletes ephemeral exchanges, and - starts the background task loop (unless ``config.lazyTaskLoop`` is - set). + Initializes the wallet: opens the wallet database (using the + native sqlite schema for a new, empty database when + ``config.features.useNativeDb`` is set, and migrating an existing + database to the native sqlite schema when + ``config.features.migrateNativeDb`` is set), installs the built-in + default exchanges (unless ``config.testing.skipDefaults`` is set), + applies ``config.logLevel`` as the global log level, runs internal + data migrations and — on the first initialization only — cleans up + failed and leftover claims and deletes ephemeral exchanges, and + starts the background task loop (unless ``config.lazyTaskLoop`` is + set). **Details:** - Initialization fails with ``WALLET_DB_UNAVAILABLE`` if the wallet - database cannot be opened for writing. + Initialization fails with ``WALLET_DB_UNAVAILABLE`` if the wallet + database cannot be opened for writing. - Calling ``initWallet`` again after a successful initialization - re-initializes the wallet with the new configuration, exactly - like :ts:op:`setWalletRunConfig`. Fields not present in - ``config`` are reset to their defaults. + Calling ``initWallet`` again after a successful initialization + re-initializes the wallet with the new configuration, exactly + like :ts:op:`setWalletRunConfig`. Fields not present in + ``config`` are reset to their defaults. .. ts:def:: InitRequest diff --git a/core/wallet-core/init/set-wallet-run-config.rst b/core/wallet-core/init/set-wallet-run-config.rst @@ -4,21 +4,21 @@ **Request:** - The request must be an `InitRequest` object. + The request must be an `InitRequest` object. **Response:** - On success, the result is an `InitResponse` object. + On success, the result is an `InitResponse` object. **Side effects:** - Re-initializes the wallet with the new configuration, with the - same effects as :ts:op:`initWallet`. + Re-initializes the wallet with the new configuration, with the + same effects as :ts:op:`initWallet`. **Details:** - This operation is currently an alias for :ts:op:`initWallet`: - both operations run the same initialization, so - ``setWalletRunConfig`` can also serve as the first request that - initializes the wallet. Fields not present in ``config`` are - reset to their defaults. + This operation is currently an alias for :ts:op:`initWallet`: + both operations run the same initialization, so + ``setWalletRunConfig`` can also serve as the first request that + initializes the wallet. Fields not present in ``config`` are + reset to their defaults. diff --git a/core/wallet-core/init/shutdown.rst b/core/wallet-core/init/shutdown.rst @@ -4,20 +4,20 @@ **Request:** - This operation takes no arguments (an empty object). + This operation takes no arguments (an empty object). **Response:** - On success, the result is an empty object. + On success, the result is an empty object. **Side effects:** - Stops the background task loop, timers and cryptographic workers - and closes the wallet database. Afterwards, every operation - other than ``shutdown`` itself fails with - ``WALLET_CORE_NOT_AVAILABLE``. + Stops the background task loop, timers and cryptographic workers + and closes the wallet database. Afterwards, every operation + other than ``shutdown`` itself fails with + ``WALLET_CORE_NOT_AVAILABLE``. **Details:** - To use the wallet again, wallet-core must be restarted and - :ts:op:`initWallet` called again. + To use the wallet again, wallet-core must be restarted and + :ts:op:`initWallet` called again. diff --git a/core/wallet-core/mailbox/add-mailbox-message.rst b/core/wallet-core/mailbox/add-mailbox-message.rst @@ -6,16 +6,16 @@ **Request:** - The request arguments are an `AddMailboxMessageRequest` object. + The request arguments are an `AddMailboxMessageRequest` object. **Response:** - On success, the result is an empty object. + On success, the result is an empty object. **Side effects:** - Stores the message in the wallet's local database and emits a - ``mailbox-message-added`` notification. + Stores the message in the wallet's local database and emits a + ``mailbox-message-added`` notification. .. ts:def:: AddMailboxMessageRequest diff --git a/core/wallet-core/mailbox/delete-mailbox-message.rst b/core/wallet-core/mailbox/delete-mailbox-message.rst @@ -4,24 +4,24 @@ **Request:** - The request arguments are a `DeleteMailboxMessageRequest` object. + The request arguments are a `DeleteMailboxMessageRequest` object. **Response:** - On success, the result is an empty object. + On success, the result is an empty object. **Side effects:** - Deletes the message from the wallet's local database and emits a - ``mailbox-message-deleted`` notification. + Deletes the message from the wallet's local database and emits a + ``mailbox-message-deleted`` notification. **Details:** - The message is identified by the ``originMailboxBaseUrl`` and - ``talerUri`` fields of the given message; the ``downloadedAt`` - field is ignored. Deleting a message that does not exist is not - an error; the ``mailbox-message-deleted`` notification is emitted - regardless. + The message is identified by the ``originMailboxBaseUrl`` and + ``talerUri`` fields of the given message; the ``downloadedAt`` + field is ignored. Deleting a message that does not exist is not + an error; the ``mailbox-message-deleted`` notification is emitted + regardless. .. ts:def:: DeleteMailboxMessageRequest diff --git a/core/wallet-core/mailbox/get-mailbox-message.rst b/core/wallet-core/mailbox/get-mailbox-message.rst @@ -9,17 +9,17 @@ **Request:** - This operation takes no arguments (an empty object). + This operation takes no arguments (an empty object). **Response:** - On success, the result is a `MailboxMessagesResponse` object. + On success, the result is a `MailboxMessagesResponse` object. **Details:** - This operation only reads the wallet's local database; use - :ts:op:`refreshMailbox` to download new messages from the mailbox - service. + This operation only reads the wallet's local database; use + :ts:op:`refreshMailbox` to download new messages from the mailbox + service. .. ts:def:: MailboxMessagesResponse diff --git a/core/wallet-core/mailbox/get-mailbox.rst b/core/wallet-core/mailbox/get-mailbox.rst @@ -6,13 +6,13 @@ **Request:** - The request arguments are a `MailboxBaseUrl` object. + The request arguments are a `MailboxBaseUrl` object. **Response:** - On success, the result is a `GetMailboxResponse` object. The - ``mailboxConfiguration`` field is absent if the wallet has no - mailbox configuration for the given base URL. + On success, the result is a `GetMailboxResponse` object. The + ``mailboxConfiguration`` field is absent if the wallet has no + mailbox configuration for the given base URL. .. ts:def:: MailboxBaseUrl diff --git a/core/wallet-core/mailbox/initialize-mailbox.rst b/core/wallet-core/mailbox/initialize-mailbox.rst @@ -6,35 +6,35 @@ **Request:** - The request arguments are a `MailboxBaseUrl` object. + The request arguments are a `MailboxBaseUrl` object. **Response:** - On success, the result is the newly created `MailboxConfiguration` - object. + On success, the result is the newly created `MailboxConfiguration` + object. **Side effects:** - Registers a new mailbox at the mailbox service over the network - and stores the configuration and keys locally. + Registers a new mailbox at the mailbox service over the network + and stores the configuration and keys locally. **Expected errors:** - The caller can handle the following errors inline: - ``WALLET_MAILBOX_UNAVAILABLE``, ``GENERIC_FORBIDDEN``, - ``WALLET_RECEIVED_MALFORMED_RESPONSE``. + The caller can handle the following errors inline: + ``WALLET_MAILBOX_UNAVAILABLE``, ``GENERIC_FORBIDDEN``, + ``WALLET_RECEIVED_MALFORMED_RESPONSE``. **Details:** - A fresh key pair is generated on every call, so each call creates - a new mailbox identity at the service. The registration is made - with an expiration one year in the future. If the mailbox service - requires payment for the registration, the operation still - succeeds and the returned configuration has ``payUri`` set, which - the client can use to pay for the registration. - ``GENERIC_FORBIDDEN`` indicates that the mailbox service refused - the registration. ``WALLET_RECEIVED_MALFORMED_RESPONSE`` indicates - that the service asked for payment but did not say how to pay. + A fresh key pair is generated on every call, so each call creates + a new mailbox identity at the service. The registration is made + with an expiration one year in the future. If the mailbox service + requires payment for the registration, the operation still + succeeds and the returned configuration has ``payUri`` set, which + the client can use to pay for the registration. + ``GENERIC_FORBIDDEN`` indicates that the mailbox service refused + the registration. ``WALLET_RECEIVED_MALFORMED_RESPONSE`` indicates + that the service asked for payment but did not say how to pay. .. ts:def:: MailboxConfiguration diff --git a/core/wallet-core/mailbox/refresh-mailbox.rst b/core/wallet-core/mailbox/refresh-mailbox.rst @@ -7,36 +7,36 @@ **Request:** - The request arguments are a `MailboxConfiguration` object for the - mailbox to refresh. + The request arguments are a `MailboxConfiguration` object for the + mailbox to refresh. **Response:** - On success, the result is a `MailboxMessageRecordsResponse` object - with the newly downloaded messages. + On success, the result is a `MailboxMessageRecordsResponse` object + with the newly downloaded messages. **Side effects:** - Downloads new messages from the mailbox service over the network, - stores them in the wallet's local database and deletes them on the - service. A ``mailbox-message-added`` notification is emitted for - each stored message. + Downloads new messages from the mailbox service over the network, + stores them in the wallet's local database and deletes them on the + service. A ``mailbox-message-added`` notification is emitted for + each stored message. **Expected errors:** - The caller can handle the following errors inline: - ``WALLET_MAILBOX_UNAVAILABLE``, ``WALLET_RECEIVED_MALFORMED_RESPONSE``. + The caller can handle the following errors inline: + ``WALLET_MAILBOX_UNAVAILABLE``, ``WALLET_RECEIVED_MALFORMED_RESPONSE``. **Details:** - The configuration of the mailbox service (message size and response - limit) is fetched before the first batch. Each downloaded message - is stored like in :ts:op:`addMailboxMessage`. Messages that cannot - be decrypted are skipped. At most 100 batches are fetched in one - call. ``WALLET_RECEIVED_MALFORMED_RESPONSE`` indicates that the - mailbox service returned an invalid response (invalid response - limit, or a message list whose size is not a multiple of the - advertised message size). + The configuration of the mailbox service (message size and response + limit) is fetched before the first batch. Each downloaded message + is stored like in :ts:op:`addMailboxMessage`. Messages that cannot + be decrypted are skipped. At most 100 batches are fetched in one + call. ``WALLET_RECEIVED_MALFORMED_RESPONSE`` indicates that the + mailbox service returned an invalid response (invalid response + limit, or a message list whose size is not a multiple of the + advertised message size). .. ts:def:: MailboxMessageRecordsResponse diff --git a/core/wallet-core/mailbox/send-taler-uri-mailbox-message.rst b/core/wallet-core/mailbox/send-taler-uri-mailbox-message.rst @@ -8,22 +8,22 @@ **Request:** - The request arguments are a `SendTalerUriMailboxMessageRequest` - object. + The request arguments are a `SendTalerUriMailboxMessageRequest` + object. **Response:** - On success, the result is an empty object. + On success, the result is an empty object. **Side effects:** - Sends the ``taler://`` URI as a message via the contact's mailbox - service over the network. Does not change local wallet state. + Sends the ``taler://`` URI as a message via the contact's mailbox + service over the network. Does not change local wallet state. **Expected errors:** - The caller can handle the following errors inline: - ``WALLET_MAILBOX_UNAVAILABLE``. + The caller can handle the following errors inline: + ``WALLET_MAILBOX_UNAVAILABLE``. .. ts:def:: SendTalerUriMailboxMessageRequest diff --git a/core/wallet-core/payments/check-pay-for-template.rst b/core/wallet-core/payments/check-pay-for-template.rst @@ -12,45 +12,45 @@ **Request:** - The ``args`` must be a `CheckPayTemplateRequest` object. + The ``args`` must be a `CheckPayTemplateRequest` object. **Response:** - On success, the result is a `CheckPayTemplateReponse` object. + On success, the result is a `CheckPayTemplateReponse` object. **Side effects:** - Fetches the payment template and the merchant's configuration over - the network; does not change wallet state. + Fetches the payment template and the merchant's configuration over + the network; does not change wallet state. **Expected errors:** - The caller can handle the following errors inline: - ``WALLET_TALER_URI_MALFORMED``, - ``WALLET_CONTRACT_TERMS_UNSUPPORTED``. + The caller can handle the following errors inline: + ``WALLET_TALER_URI_MALFORMED``, + ``WALLET_CONTRACT_TERMS_UNSUPPORTED``. **Details:** - The ``templateDetails`` field is the template information served - by the merchant backend (a `WalletTemplateDetailsResponse` of the - merchant API), with the URI overrides already applied. - - ``availableBalances`` is returned for all template types, including - fixed and editable amounts. It includes wallet balances whose scope - currency appears in ``supportedCurrencies``, preserving the scopes - and ordering from :ts:op:`getBalances`. Known zero balances are - included; an empty array means there are no matching balance entries. - No scopes are synthesized. - - ``amountAvailable`` uses the same semantics as ``getBalances.available``, - including expected pending refresh outputs. It is not a guaranteed - maximum payment amount or proof of merchant acceptance. Merchant - acceptance, age restrictions, fees and final payment eligibility are - checked during payment preparation. Template currency requirements - still apply, and balances may change after the response. Missing or - empty advisory ``exchange_candidates`` do not suppress balances. - Clients must not use this snapshot as an authoritative affordability - check or exact input limit. + The ``templateDetails`` field is the template information served + by the merchant backend (a `WalletTemplateDetailsResponse` of the + merchant API), with the URI overrides already applied. + + ``availableBalances`` is returned for all template types, including + fixed and editable amounts. It includes wallet balances whose scope + currency appears in ``supportedCurrencies``, preserving the scopes + and ordering from :ts:op:`getBalances`. Known zero balances are + included; an empty array means there are no matching balance entries. + No scopes are synthesized. + + ``amountAvailable`` uses the same semantics as ``getBalances.available``, + including expected pending refresh outputs. It is not a guaranteed + maximum payment amount or proof of merchant acceptance. Merchant + acceptance, age restrictions, fees and final payment eligibility are + checked during payment preparation. Template currency requirements + still apply, and balances may change after the response. Missing or + empty advisory ``exchange_candidates`` do not suppress balances. + Clients must not use this snapshot as an authoritative affordability + check or exact input limit. .. ts:def:: CheckPayTemplateRequest diff --git a/core/wallet-core/payments/confirm-pay.rst b/core/wallet-core/payments/confirm-pay.rst @@ -11,38 +11,38 @@ **Request:** - The ``args`` must be a `ConfirmPayRequest` object. + The ``args`` must be a `ConfirmPayRequest` object. **Response:** - On success, the result is a `ConfirmPayResult` object. + On success, the result is a `ConfirmPayResult` object. **Side effects:** - Confirms the prepared payment: the wallet spends the coins and - submits the payment to the merchant over the network. + Confirms the prepared payment: the wallet spends the coins and + submits the payment to the merchant over the network. **Expected errors:** - The caller can handle the following errors inline: - ``WALLET_PAY_MERCHANT_INSUFFICIENT_BALANCE``, - ``WALLET_TRANSACTION_NOT_FOUND``, - ``WALLET_REQUEST_TRANSACTION_STATE_UNSUPPORTED``, - ``WALLET_CORE_API_BAD_REQUEST``. + The caller can handle the following errors inline: + ``WALLET_PAY_MERCHANT_INSUFFICIENT_BALANCE``, + ``WALLET_TRANSACTION_NOT_FOUND``, + ``WALLET_REQUEST_TRANSACTION_STATE_UNSUPPORTED``, + ``WALLET_CORE_API_BAD_REQUEST``. **Details:** - Unless ``noWait`` is set, the operation waits for the first - payment result: when the payment succeeded, the result has type - ``done``; when the payment could not be completed (yet), the - result has type ``pending`` and carries the last error of the - payment. With ``noWait``, the operation returns a ``pending`` - result immediately and the payment status is communicated via - notifications. - - The ``WALLET_PAY_MERCHANT_INSUFFICIENT_BALANCE`` error carries - ``insufficientBalanceDetails`` of type - `PaymentInsufficientBalanceDetails` in its error detail. + Unless ``noWait`` is set, the operation waits for the first + payment result: when the payment succeeded, the result has type + ``done``; when the payment could not be completed (yet), the + result has type ``pending`` and carries the last error of the + payment. With ``noWait``, the operation returns a ``pending`` + result immediately and the payment status is communicated via + notifications. + + The ``WALLET_PAY_MERCHANT_INSUFFICIENT_BALANCE`` error carries + ``insufficientBalanceDetails`` of type + `PaymentInsufficientBalanceDetails` in its error detail. .. ts:def:: PaymentInsufficientBalanceDetails diff --git a/core/wallet-core/payments/get-choices-for-payment.rst b/core/wallet-core/payments/get-choices-for-payment.rst @@ -13,28 +13,28 @@ **Request:** - The ``args`` must be a `GetChoicesForPaymentRequest` object. + The ``args`` must be a `GetChoicesForPaymentRequest` object. **Response:** - On success, the result is a `GetChoicesForPaymentResult` object. + On success, the result is a `GetChoicesForPaymentResult` object. **Side effects:** - None; this operation is a pure read. The payability of each choice - is evaluated against the coin, exchange and token information - already stored in the wallet database, without any network access. + None; this operation is a pure read. The payability of each choice + is evaluated against the coin, exchange and token information + already stored in the wallet database, without any network access. **Expected errors:** - The caller can handle the following errors inline: - ``WALLET_REQUEST_TRANSACTION_STATE_UNSUPPORTED``, - ``WALLET_TRANSACTION_NOT_FOUND``, ``WALLET_CORE_API_BAD_REQUEST``. + The caller can handle the following errors inline: + ``WALLET_REQUEST_TRANSACTION_STATE_UNSUPPORTED``, + ``WALLET_TRANSACTION_NOT_FOUND``, ``WALLET_CORE_API_BAD_REQUEST``. - The ``WALLET_REQUEST_TRANSACTION_STATE_UNSUPPORTED`` error is - returned while the contract terms of the payment have not been - downloaded yet; the caller should wait for the corresponding - transaction state transition and try again. + The ``WALLET_REQUEST_TRANSACTION_STATE_UNSUPPORTED`` error is + returned while the contract terms of the payment have not been + downloaded yet; the caller should wait for the corresponding + transaction state transition and try again. .. ts:def:: GetChoicesForPaymentRequest diff --git a/core/wallet-core/payments/get-paivana-cookie.rst b/core/wallet-core/payments/get-paivana-cookie.rst @@ -13,29 +13,29 @@ **Request:** - The ``args`` must be a `GetPaivanaCookieRequest` object. + The ``args`` must be a `GetPaivanaCookieRequest` object. **Response:** - On success, the result is a `GetPaivanaCookieResult` object. + On success, the result is a `GetPaivanaCookieResult` object. **Side effects:** - Redeems the paid Paivana transaction for an access cookie via an - HTTP POST to the resource server. + Redeems the paid Paivana transaction for an access cookie via an + HTTP POST to the resource server. **Expected errors:** - The caller can handle the following errors inline: - ``WALLET_CORE_API_BAD_REQUEST``, ``WALLET_TRANSACTION_NOT_FOUND``, - ``WALLET_REQUEST_TRANSACTION_STATE_UNSUPPORTED``, - ``WALLET_RECEIVED_MALFORMED_RESPONSE``, ``WALLET_NETWORK_ERROR``, - ``WALLET_HTTP_REQUEST_THROTTLED``, - ``WALLET_HTTP_REQUEST_GENERIC_TIMEOUT``, ``PAIVANA_PAYMENT_MISSING``, - ``PAIVANA_BACKEND_REFUSED``, ``PAIVANA_ORDER_UNKNOWN``, - ``PAIVANA_BACKEND_ERROR``, ``PAIVANA_GET_ORDER_FAILED``, - ``PAIVANA_WRONG_ORDER``, ``PAIVANA_TOO_LATE``, - ``PAIVANA_INVALID_TARGET``. + The caller can handle the following errors inline: + ``WALLET_CORE_API_BAD_REQUEST``, ``WALLET_TRANSACTION_NOT_FOUND``, + ``WALLET_REQUEST_TRANSACTION_STATE_UNSUPPORTED``, + ``WALLET_RECEIVED_MALFORMED_RESPONSE``, ``WALLET_NETWORK_ERROR``, + ``WALLET_HTTP_REQUEST_THROTTLED``, + ``WALLET_HTTP_REQUEST_GENERIC_TIMEOUT``, ``PAIVANA_PAYMENT_MISSING``, + ``PAIVANA_BACKEND_REFUSED``, ``PAIVANA_ORDER_UNKNOWN``, + ``PAIVANA_BACKEND_ERROR``, ``PAIVANA_GET_ORDER_FAILED``, + ``PAIVANA_WRONG_ORDER``, ``PAIVANA_TOO_LATE``, + ``PAIVANA_INVALID_TARGET``. .. ts:def:: GetPaivanaCookieRequest diff --git a/core/wallet-core/payments/prepare-pay-for-paivana.rst b/core/wallet-core/payments/prepare-pay-for-paivana.rst @@ -13,26 +13,26 @@ **Request:** - The ``args`` must be a `PreparePayForPaivanaRequest` object. + The ``args`` must be a `PreparePayForPaivanaRequest` object. **Response:** - On success, the result is a `PreparePayForPaivanaResult` object. + On success, the result is a `PreparePayForPaivanaResult` object. **Side effects:** - Fetches the contract terms for the Paivana-protected resource over - the network and creates a payment transaction in dialog state. + Fetches the contract terms for the Paivana-protected resource over + the network and creates a payment transaction in dialog state. **Expected errors:** - The caller can handle the following errors inline: - ``WALLET_CORE_API_BAD_REQUEST``, - ``WALLET_RECEIVED_MALFORMED_RESPONSE``, ``WALLET_NETWORK_ERROR``, - ``WALLET_HTTP_REQUEST_THROTTLED``, - ``WALLET_HTTP_REQUEST_GENERIC_TIMEOUT``, - ``WALLET_UNEXPECTED_REQUEST_ERROR``, - ``WALLET_CONTRACT_TERMS_UNSUPPORTED``. + The caller can handle the following errors inline: + ``WALLET_CORE_API_BAD_REQUEST``, + ``WALLET_RECEIVED_MALFORMED_RESPONSE``, ``WALLET_NETWORK_ERROR``, + ``WALLET_HTTP_REQUEST_THROTTLED``, + ``WALLET_HTTP_REQUEST_GENERIC_TIMEOUT``, + ``WALLET_UNEXPECTED_REQUEST_ERROR``, + ``WALLET_CONTRACT_TERMS_UNSUPPORTED``. .. ts:def:: PreparePayForPaivanaRequest diff --git a/core/wallet-core/payments/prepare-pay-for-template-v2.rst b/core/wallet-core/payments/prepare-pay-for-template-v2.rst @@ -11,22 +11,22 @@ **Request:** - The ``args`` must be a `PreparePayTemplateRequest` object. + The ``args`` must be a `PreparePayTemplateRequest` object. **Response:** - On success, the result is a `PreparePayV2Result` object. + On success, the result is a `PreparePayV2Result` object. **Side effects:** - Fetches the payment template from the merchant over the network - and creates a payment transaction in dialog state. + Fetches the payment template from the merchant over the network + and creates a payment transaction in dialog state. **Expected errors:** - The caller can handle the following errors inline: - ``WALLET_TALER_URI_MALFORMED``, - ``WALLET_CONTRACT_TERMS_UNSUPPORTED``. + The caller can handle the following errors inline: + ``WALLET_TALER_URI_MALFORMED``, + ``WALLET_CONTRACT_TERMS_UNSUPPORTED``. .. ts:def:: PreparePayTemplateRequest diff --git a/core/wallet-core/payments/prepare-pay-for-uri-v2.rst b/core/wallet-core/payments/prepare-pay-for-uri-v2.rst @@ -10,33 +10,33 @@ **Request:** - The ``args`` must be a `PreparePayRequest` object. + The ``args`` must be a `PreparePayRequest` object. **Response:** - On success, the result is a `PreparePayV2Result` object. + On success, the result is a `PreparePayV2Result` object. **Side effects:** - The operation itself is deliberately local-only: it creates (or - reuses) the payment transaction record in the wallet database and - wakes the transaction's background task. Claiming the order and - downloading the contract terms from the merchant happen - asynchronously as part of the transaction's processing; the - transaction moves to dialog state once the contract terms have been - downloaded. + The operation itself is deliberately local-only: it creates (or + reuses) the payment transaction record in the wallet database and + wakes the transaction's background task. Claiming the order and + downloading the contract terms from the merchant happen + asynchronously as part of the transaction's processing; the + transaction moves to dialog state once the contract terms have been + downloaded. **Expected errors:** - The caller can handle the following errors inline: - ``WALLET_INVALID_TALER_PAY_URI``. + The caller can handle the following errors inline: + ``WALLET_INVALID_TALER_PAY_URI``. - Errors from claiming the order and downloading the contract terms - (such as ``WALLET_MERCHANT_ORDER_NOT_FOUND``, - ``WALLET_ORDER_ALREADY_CLAIMED``, ``WALLET_ORDER_ALREADY_PAID``, - ``WALLET_CONTRACT_TERMS_MALFORMED`` or - ``WALLET_CONTRACT_TERMS_UNSUPPORTED``) do not fail this operation; - they are reported as the last error of the payment transaction. + Errors from claiming the order and downloading the contract terms + (such as ``WALLET_MERCHANT_ORDER_NOT_FOUND``, + ``WALLET_ORDER_ALREADY_CLAIMED``, ``WALLET_ORDER_ALREADY_PAID``, + ``WALLET_CONTRACT_TERMS_MALFORMED`` or + ``WALLET_CONTRACT_TERMS_UNSUPPORTED``) do not fail this operation; + they are reported as the last error of the payment transaction. .. ts:def:: PreparePayRequest diff --git a/core/wallet-core/payments/reclaim-payment.rst b/core/wallet-core/payments/reclaim-payment.rst @@ -6,22 +6,22 @@ **Request:** - The ``args`` must be a `ReclaimPaymentRequest` object. + The ``args`` must be a `ReclaimPaymentRequest` object. **Response:** - On success, the result is an empty object. + On success, the result is an empty object. **Side effects:** - Reclaims a payment previously handed off to another wallet; - changes the transaction state. + Reclaims a payment previously handed off to another wallet; + changes the transaction state. **Expected errors:** - The caller can handle the following errors inline: - ``WALLET_TRANSACTION_NOT_FOUND``, - ``WALLET_REQUEST_TRANSACTION_STATE_UNSUPPORTED``. + The caller can handle the following errors inline: + ``WALLET_TRANSACTION_NOT_FOUND``, + ``WALLET_REQUEST_TRANSACTION_STATE_UNSUPPORTED``. .. ts:def:: ReclaimPaymentRequest diff --git a/core/wallet-core/payments/start-refund-query-for-uri.rst b/core/wallet-core/payments/start-refund-query-for-uri.rst @@ -10,22 +10,22 @@ **Request:** - The ``args`` must be a `PrepareRefundRequest` object. + The ``args`` must be a `PrepareRefundRequest` object. **Response:** - On success, the result is a `StartRefundQueryForUriResponse` - object. + On success, the result is a `StartRefundQueryForUriResponse` + object. **Side effects:** - Creates or updates a refund query and contacts the merchant over - the network. + Creates or updates a refund query and contacts the merchant over + the network. **Expected errors:** - The caller can handle the following errors inline: - ``WALLET_TALER_URI_MALFORMED``, ``WALLET_PURCHASE_NOT_FOUND``. + The caller can handle the following errors inline: + ``WALLET_TALER_URI_MALFORMED``, ``WALLET_PURCHASE_NOT_FOUND``. .. ts:def:: PrepareRefundRequest diff --git a/core/wallet-core/payments/start-refund-query.rst b/core/wallet-core/payments/start-refund-query.rst @@ -7,16 +7,16 @@ **Request:** - The ``args`` must be a `StartRefundQueryRequest` object. + The ``args`` must be a `StartRefundQueryRequest` object. **Response:** - On success, the result is an empty object. + On success, the result is an empty object. **Side effects:** - Starts a refund query for an existing payment transaction, - contacting the merchant over the network. + Starts a refund query for an existing payment transaction, + contacting the merchant over the network. .. ts:def:: StartRefundQueryRequest diff --git a/core/wallet-core/payments/unclaim-payment.rst b/core/wallet-core/payments/unclaim-payment.rst @@ -12,25 +12,25 @@ **Request:** - The ``args`` must be an `UnclaimPaymentRequest` object. + The ``args`` must be an `UnclaimPaymentRequest` object. **Response:** - On success, the result is an `UnclaimPaymentResult` object. + On success, the result is an `UnclaimPaymentResult` object. **Side effects:** - Unclaims the payment at the merchant and generates a taler://pay - URI that allows another wallet to complete it; changes the - transaction state. + Unclaims the payment at the merchant and generates a taler://pay + URI that allows another wallet to complete it; changes the + transaction state. **Expected errors:** - The caller can handle the following errors inline: - ``WALLET_TRANSACTION_NOT_FOUND``, - ``WALLET_REQUEST_TRANSACTION_STATE_UNSUPPORTED``, - ``WALLET_CORE_REQUEST_CANCELLED``, - ``WALLET_UNEXPECTED_REQUEST_ERROR``. + The caller can handle the following errors inline: + ``WALLET_TRANSACTION_NOT_FOUND``, + ``WALLET_REQUEST_TRANSACTION_STATE_UNSUPPORTED``, + ``WALLET_CORE_REQUEST_CANCELLED``, + ``WALLET_UNEXPECTED_REQUEST_ERROR``. .. ts:def:: UnclaimPaymentRequest diff --git a/core/wallet-core/taldir/complete-register-alias.rst b/core/wallet-core/taldir/complete-register-alias.rst @@ -6,31 +6,31 @@ **Request:** - The request arguments are a `TaldirRegistrationCompletionRequest` - object. + The request arguments are a `TaldirRegistrationCompletionRequest` + object. **Response:** - On success, the result is an empty object. + On success, the result is an empty object. **Side effects:** - Completes the pending alias registration at the taldir service by - submitting the challenge response over the network. + Completes the pending alias registration at the taldir service by + submitting the challenge response over the network. **Expected errors:** - The caller can handle the following errors inline: - ``WALLET_ALIAS_REGISTRATION_FAILED``, ``GENERIC_FORBIDDEN``. + The caller can handle the following errors inline: + ``WALLET_ALIAS_REGISTRATION_FAILED``, ``GENERIC_FORBIDDEN``. **Details:** - Wallet-core derives the answer sent to the service as the hash of - the ``challenge`` together with the ``targetUri`` from the - registration request, which protects the user against authorizing - a concurrent registration of a different target URI. - ``GENERIC_FORBIDDEN`` indicates that the service rejected the - answer to the challenge. + Wallet-core derives the answer sent to the service as the hash of + the ``challenge`` together with the ``targetUri`` from the + registration request, which protects the user against authorizing + a concurrent registration of a different target URI. + ``GENERIC_FORBIDDEN`` indicates that the service rejected the + answer to the challenge. .. ts:def:: TaldirRegistrationCompletionRequest diff --git a/core/wallet-core/taldir/lookup-alias.rst b/core/wallet-core/taldir/lookup-alias.rst @@ -4,23 +4,23 @@ **Request:** - The request arguments are a `TaldirLookupRequest` object. + The request arguments are a `TaldirLookupRequest` object. **Response:** - On success, the result is a `TaldirLookupResponse` object. The - ``targetUri`` field is absent if the alias is not registered, or - if the service does not support the requested alias type. + On success, the result is a `TaldirLookupResponse` object. The + ``targetUri`` field is absent if the alias is not registered, or + if the service does not support the requested alias type. **Side effects:** - Queries the taldir directory service over the network; does not - change wallet state. + Queries the taldir directory service over the network; does not + change wallet state. **Expected errors:** - The caller can handle the following errors inline: - ``WALLET_ALIAS_REGISTRATION_FAILED``. + The caller can handle the following errors inline: + ``WALLET_ALIAS_REGISTRATION_FAILED``. .. ts:def:: TaldirLookupRequest diff --git a/core/wallet-core/taldir/register-alias.rst b/core/wallet-core/taldir/register-alias.rst @@ -10,24 +10,24 @@ **Request:** - The request arguments are a `TaldirRegistrationRequest` object. + The request arguments are a `TaldirRegistrationRequest` object. **Response:** - On success, the result is a `TaldirRegistrationResponse`: an empty - object if a challenge was sent to the alias, or a - `TaldirAlreadyPaidResponse` object if the registration already - exists and is still paid for. + On success, the result is a `TaldirRegistrationResponse`: an empty + object if a challenge was sent to the alias, or a + `TaldirAlreadyPaidResponse` object if the registration already + exists and is still paid for. **Side effects:** - Requests the alias registration at the taldir service over the - network; the service may require payment for the registration. + Requests the alias registration at the taldir service over the + network; the service may require payment for the registration. **Expected errors:** - The caller can handle the following errors inline: - ``WALLET_ALIAS_REGISTRATION_FAILED``. + The caller can handle the following errors inline: + ``WALLET_ALIAS_REGISTRATION_FAILED``. .. ts:def:: TaldirRegistrationRequest diff --git a/core/wallet-core/testing/apply-dev-experiment.rst b/core/wallet-core/testing/apply-dev-experiment.rst @@ -7,16 +7,16 @@ **Request:** - The request must be an `ApplyDevExperimentRequest` object. + The request must be an `ApplyDevExperimentRequest` object. **Response:** - On success, the result is an empty object. + On success, the result is an empty object. **Side effects:** - Applies arbitrary changes to the wallet's state and database, - depending on the experiment. + Applies arbitrary changes to the wallet's state and database, + depending on the experiment. .. ts:def:: ApplyDevExperimentRequest diff --git a/core/wallet-core/testing/dump-coins.rst b/core/wallet-core/testing/dump-coins.rst @@ -5,11 +5,11 @@ **Request:** - This operation takes no arguments (an empty object). + This operation takes no arguments (an empty object). **Response:** - On success, the result is a `CoinDumpJson` object. + On success, the result is a `CoinDumpJson` object. .. ts:def:: CoinDumpJson diff --git a/core/wallet-core/testing/force-refresh.rst b/core/wallet-core/testing/force-refresh.rst @@ -5,23 +5,23 @@ **Request:** - The request must be a `ForceRefreshRequest` object. + The request must be a `ForceRefreshRequest` object. **Response:** - On success, the result is an empty object. + On success, the result is an empty object. **Side effects:** - Refreshes the given coins at the exchange over the network even - where a refresh would not be necessary; creates refresh - transactions. + Refreshes the given coins at the exchange over the network even + where a refresh would not be necessary; creates refresh + transactions. **Details:** - The request fails if ``refreshCoinSpecs`` is empty or names a coin - that is unknown to the wallet. Each coin is refreshed for its full - denomination value, unless a smaller ``amount`` is given. + The request fails if ``refreshCoinSpecs`` is empty or names a coin + that is unknown to the wallet. Each coin is refreshed for its full + denomination value, unless a smaller ``amount`` is given. .. ts:def:: ForceRefreshRequest diff --git a/core/wallet-core/testing/run-integration-test-v2.rst b/core/wallet-core/testing/run-integration-test-v2.rst @@ -7,16 +7,16 @@ **Request:** - The request must be an `IntegrationTestV2Args` object. + The request must be an `IntegrationTestV2Args` object. **Response:** - On success, the result is an empty object. + On success, the result is an empty object. **Side effects:** - Performs real withdrawals, payments, a refund, peer-to-peer - payments and a deposit at the test deployment over the network. + Performs real withdrawals, payments, a refund, peer-to-peer + payments and a deposit at the test deployment over the network. .. ts:def:: IntegrationTestV2Args diff --git a/core/wallet-core/testing/run-integration-test.rst b/core/wallet-core/testing/run-integration-test.rst @@ -10,16 +10,16 @@ **Request:** - The request must be an `IntegrationTestArgs` object. + The request must be an `IntegrationTestArgs` object. **Response:** - On success, the result is an empty object. + On success, the result is an empty object. **Side effects:** - Performs real withdrawals, payments and a refund at the test - deployment over the network. + Performs real withdrawals, payments and a refund at the test + deployment over the network. .. ts:def:: IntegrationTestArgs diff --git a/core/wallet-core/testing/set-coin-suspended.rst b/core/wallet-core/testing/set-coin-suspended.rst @@ -5,24 +5,24 @@ **Request:** - The request must be a `SetCoinSuspendedRequest` object. + The request must be a `SetCoinSuspendedRequest` object. **Response:** - On success, the result is an empty object. + On success, the result is an empty object. **Side effects:** - Marks the coin as (un-)suspended; suspended coins are excluded from - payments. + Marks the coin as (un-)suspended; suspended coins are excluded from + payments. **Details:** - Only fresh coins can be suspended, and only suspended coins can be - un-suspended; requesting any other status transition is a no-op. - An unknown ``coinPub`` is silently ignored (a warning is logged). - Suspension updates the coin availability counters of the - denomination accordingly. + Only fresh coins can be suspended, and only suspended coins can be + un-suspended; requesting any other status transition is a no-op. + An unknown ``coinPub`` is silently ignored (a warning is logged). + Suspension updates the coin availability counters of the + denomination accordingly. .. ts:def:: SetCoinSuspendedRequest diff --git a/core/wallet-core/testing/test-crypto.rst b/core/wallet-core/testing/test-crypto.rst @@ -5,8 +5,8 @@ **Request:** - This operation takes no arguments (an empty object). + This operation takes no arguments (an empty object). **Response:** - On success, the result is an unspecified JSON value. + On success, the result is an unspecified JSON value. diff --git a/core/wallet-core/testing/test-pay.rst b/core/wallet-core/testing/test-pay.rst @@ -6,16 +6,16 @@ **Request:** - The request must be a `TestPayArgs` object. + The request must be a `TestPayArgs` object. **Response:** - On success, the result is a `TestPayResult` object. + On success, the result is a `TestPayResult` object. **Side effects:** - Creates an order and makes a real payment at the test merchant over - the network. + Creates an order and makes a real payment at the test merchant over + the network. .. ts:def:: TestPayArgs diff --git a/core/wallet-core/testing/testing-check-coins.rst b/core/wallet-core/testing/testing-check-coins.rst @@ -5,16 +5,16 @@ **Request:** - The request must be a `TestingCheckCoinsRequest` object. + The request must be a `TestingCheckCoinsRequest` object. **Response:** - On success, the result is a `TestingCheckCoinsResponse` object. + On success, the result is a `TestingCheckCoinsResponse` object. **Side effects:** - Queries the coin history from the exchange over the network for - every checked coin. + Queries the coin history from the exchange over the network for + every checked coin. .. ts:def:: TestingCheckCoinsRequest diff --git a/core/wallet-core/testing/testing-corrupt-withdrawal-coin-sel.rst b/core/wallet-core/testing/testing-corrupt-withdrawal-coin-sel.rst @@ -6,23 +6,23 @@ **Request:** - The request must be a `TestingCorruptWithdrawalCoinSelRequest` - object. + The request must be a `TestingCorruptWithdrawalCoinSelRequest` + object. **Response:** - On success, the result is an empty object. + On success, the result is an empty object. **Side effects:** - Intentionally corrupts the withdrawal's coin selection in the - wallet database (test failure injection). + Intentionally corrupts the withdrawal's coin selection in the + wallet database (test failure injection). **Details:** - The ``transactionId`` must identify a withdrawal transaction. - Withdrawal groups without a denomination selection are left - unchanged. + The ``transactionId`` must identify a withdrawal transaction. + Withdrawal groups without a denomination selection are left + unchanged. .. ts:def:: TestingCorruptWithdrawalCoinSelRequest diff --git a/core/wallet-core/testing/testing-get-db-stats.rst b/core/wallet-core/testing/testing-get-db-stats.rst @@ -6,8 +6,8 @@ **Request:** - This operation takes no arguments (an empty object). + This operation takes no arguments (an empty object). **Response:** - On success, the result is an unspecified JSON value. + On success, the result is an unspecified JSON value. diff --git a/core/wallet-core/testing/testing-get-denom-stats.rst b/core/wallet-core/testing/testing-get-denom-stats.rst @@ -6,11 +6,11 @@ **Request:** - The request must be a `TestingGetDenomStatsRequest` object. + The request must be a `TestingGetDenomStatsRequest` object. **Response:** - On success, the result is a `TestingGetDenomStatsResponse` object. + On success, the result is a `TestingGetDenomStatsResponse` object. .. ts:def:: TestingGetDenomStatsRequest diff --git a/core/wallet-core/testing/testing-get-flight-records.rst b/core/wallet-core/testing/testing-get-flight-records.rst @@ -8,12 +8,12 @@ **Request:** - This operation takes no arguments (an empty object). + This operation takes no arguments (an empty object). **Response:** - On success, the result is a `TestingGetFlightRecordsResponse` - object. + On success, the result is a `TestingGetFlightRecordsResponse` + object. .. ts:def:: TestingGetFlightRecordsResponse diff --git a/core/wallet-core/testing/testing-get-performance-stats.rst b/core/wallet-core/testing/testing-get-performance-stats.rst @@ -10,11 +10,11 @@ **Request:** - The request must be a `GetPerformanceStatsRequest` object. + The request must be a `GetPerformanceStatsRequest` object. **Response:** - On success, the result is a `GetPerformanceStatsResponse` object. + On success, the result is a `GetPerformanceStatsResponse` object. .. ts:def:: GetPerformanceStatsRequest diff --git a/core/wallet-core/testing/testing-get-reserve-history.rst b/core/wallet-core/testing/testing-get-reserve-history.rst @@ -6,16 +6,16 @@ **Request:** - The request must be a `TestingGetReserveHistoryRequest` object. + The request must be a `TestingGetReserveHistoryRequest` object. **Response:** - On success, the result is an unspecified JSON value with the - reserve history as returned by the exchange. + On success, the result is an unspecified JSON value with the + reserve history as returned by the exchange. **Side effects:** - Queries the reserve history from the exchange over the network. + Queries the reserve history from the exchange over the network. .. ts:def:: TestingGetReserveHistoryRequest diff --git a/core/wallet-core/testing/testing-get-sample-transactions.rst b/core/wallet-core/testing/testing-get-sample-transactions.rst @@ -6,8 +6,8 @@ **Request:** - This operation takes no arguments (an empty object). + This operation takes no arguments (an empty object). **Response:** - On success, the result is a `TransactionsResponse` object. + On success, the result is a `TransactionsResponse` object. diff --git a/core/wallet-core/testing/testing-ping.rst b/core/wallet-core/testing/testing-ping.rst @@ -6,8 +6,8 @@ **Request:** - This operation takes no arguments (an empty object). + This operation takes no arguments (an empty object). **Response:** - On success, the result is an empty object. + On success, the result is an empty object. diff --git a/core/wallet-core/testing/testing-plan-migrate-exchange-base-url.rst b/core/wallet-core/testing/testing-plan-migrate-exchange-base-url.rst @@ -9,17 +9,17 @@ **Request:** - The request must be a `TestingPlanMigrateExchangeBaseUrlRequest` - object. + The request must be a `TestingPlanMigrateExchangeBaseUrlRequest` + object. **Response:** - On success, the result is an empty object. + On success, the result is an empty object. **Side effects:** - Enables a pending exchange base URL migration, which is applied - once the exchange advertises the new base URL. + Enables a pending exchange base URL migration, which is applied + once the exchange advertises the new base URL. .. ts:def:: TestingPlanMigrateExchangeBaseUrlRequest diff --git a/core/wallet-core/testing/testing-recover-coins.rst b/core/wallet-core/testing/testing-recover-coins.rst @@ -4,17 +4,17 @@ **Request:** - The request must be a `TestingRecoverCoinsRequest` object. + The request must be a `TestingRecoverCoinsRequest` object. **Response:** - On success, the result is a `TestingRecoverCoinsResponse` object. + On success, the result is a `TestingRecoverCoinsResponse` object. **Side effects:** - Scans the exchange for coins belonging to the wallet over the - network and re-claims the coins it finds, creating transactions and - emitting notifications. + Scans the exchange for coins belonging to the wallet over the + network and re-claims the coins it finds, creating transactions and + emitting notifications. .. ts:def:: TestingRecoverCoinsRequest diff --git a/core/wallet-core/testing/testing-reset-all-retries.rst b/core/wallet-core/testing/testing-reset-all-retries.rst @@ -5,13 +5,13 @@ **Request:** - This operation takes no arguments (an empty object). + This operation takes no arguments (an empty object). **Response:** - On success, the result is an empty object. + On success, the result is an empty object. **Side effects:** - Resets the retry backoff of all tasks and transactions, causing - immediate retries and thus network activity. + Resets the retry backoff of all tasks and transactions, causing + immediate retries and thus network activity. diff --git a/core/wallet-core/testing/testing-run-fixup.rst b/core/wallet-core/testing/testing-run-fixup.rst @@ -5,15 +5,15 @@ **Request:** - The request must be a `RunFixupRequest` object. + The request must be a `RunFixupRequest` object. **Response:** - On success, the result is an empty object. + On success, the result is an empty object. **Side effects:** - Runs a database fixup that modifies stored data. + Runs a database fixup that modifies stored data. .. ts:def:: RunFixupRequest diff --git a/core/wallet-core/testing/testing-set-timetravel.rst b/core/wallet-core/testing/testing-set-timetravel.rst @@ -4,16 +4,16 @@ **Request:** - The request must be a `TestingSetTimetravelRequest` object. + The request must be a `TestingSetTimetravelRequest` object. **Response:** - On success, the result is an empty object. + On success, the result is an empty object. **Side effects:** - Offsets the wallet's internal clock, affecting all time-based logic - of the wallet. + Offsets the wallet's internal clock, affecting all time-based logic + of the wallet. .. ts:def:: TestingSetTimetravelRequest diff --git a/core/wallet-core/testing/testing-wait-balance.rst b/core/wallet-core/testing/testing-wait-balance.rst @@ -9,11 +9,11 @@ **Request:** - The request must be a `TestingWaitBalanceRequest` object. + The request must be a `TestingWaitBalanceRequest` object. **Response:** - On success, the result is an empty object. + On success, the result is an empty object. .. ts:def:: TestingWaitBalanceRequest diff --git a/core/wallet-core/testing/testing-wait-exchange-ready.rst b/core/wallet-core/testing/testing-wait-exchange-ready.rst @@ -5,16 +5,16 @@ **Request:** - The request must be a `TestingWaitExchangeReadyRequest` object. + The request must be a `TestingWaitExchangeReadyRequest` object. **Response:** - On success, the result is an empty object. + On success, the result is an empty object. **Side effects:** - May trigger an update of the exchange entry over the network, for - example when ``forceUpdate`` is set. + May trigger an update of the exchange entry over the network, for + example when ``forceUpdate`` is set. .. ts:def:: TestingWaitExchangeReadyRequest diff --git a/core/wallet-core/testing/testing-wait-exchange-state.rst b/core/wallet-core/testing/testing-wait-exchange-state.rst @@ -8,11 +8,11 @@ **Request:** - The request must be a `TestingWaitExchangeStateRequest` object. + The request must be a `TestingWaitExchangeStateRequest` object. **Response:** - On success, the result is an empty object. + On success, the result is an empty object. .. ts:def:: TestingWaitExchangeStateRequest diff --git a/core/wallet-core/testing/testing-wait-refreshes-final.rst b/core/wallet-core/testing/testing-wait-refreshes-final.rst @@ -7,8 +7,8 @@ **Request:** - This operation takes no arguments (an empty object). + This operation takes no arguments (an empty object). **Response:** - On success, the result is an empty object. + On success, the result is an empty object. diff --git a/core/wallet-core/testing/testing-wait-tasks-done.rst b/core/wallet-core/testing/testing-wait-tasks-done.rst @@ -7,8 +7,8 @@ **Request:** - This operation takes no arguments (an empty object). + This operation takes no arguments (an empty object). **Response:** - On success, the result is an empty object. + On success, the result is an empty object. diff --git a/core/wallet-core/testing/testing-wait-transaction-state.rst b/core/wallet-core/testing/testing-wait-transaction-state.rst @@ -12,8 +12,8 @@ **Request:** - The request must be a `WaitTransactionStateRequest` object. + The request must be a `WaitTransactionStateRequest` object. **Response:** - On success, the result is a `WaitTransactionStateResponse` object. + On success, the result is a `WaitTransactionStateResponse` object. diff --git a/core/wallet-core/testing/testing-wait-transactions-final.rst b/core/wallet-core/testing/testing-wait-transactions-final.rst @@ -7,8 +7,8 @@ **Request:** - This operation takes no arguments (an empty object). + This operation takes no arguments (an empty object). **Response:** - On success, the result is an empty object. + On success, the result is an empty object. diff --git a/core/wallet-core/testing/testing-wait-wallet-kyc.rst b/core/wallet-core/testing/testing-wait-wallet-kyc.rst @@ -9,11 +9,11 @@ **Request:** - The request must be a `TestingWaitWalletKycRequest` object. + The request must be a `TestingWaitWalletKycRequest` object. **Response:** - On success, the result is an empty object. + On success, the result is an empty object. .. ts:def:: TestingWaitWalletKycRequest diff --git a/core/wallet-core/testing/withdraw-test-balance.rst b/core/wallet-core/testing/withdraw-test-balance.rst @@ -4,25 +4,25 @@ **Request:** - The request must be a `WithdrawTestBalanceRequest` object. + The request must be a `WithdrawTestBalanceRequest` object. **Response:** - On success, the result is a `WithdrawTestBalanceResult` object. + On success, the result is a `WithdrawTestBalanceResult` object. **Side effects:** - Registers a random bank user and performs a real withdrawal at the - given test deployment over the network; creates a withdrawal - transaction in the wallet. + Registers a random bank user and performs a real withdrawal at the + given test deployment over the network; creates a withdrawal + transaction in the wallet. **Details:** - The operation registers a random bank user via the corebank API, - creates a withdrawal operation for the requested amount, accepts - the resulting withdrawal URI as a bank-integrated withdrawal at the - given exchange, and finally confirms the withdrawal operation at - the bank. + The operation registers a random bank user via the corebank API, + creates a withdrawal operation for the requested amount, accepts + the resulting withdrawal URI as a bank-integrated withdrawal at the + given exchange, and finally confirms the withdrawal operation at + the bank. .. ts:def:: WithdrawTestBalanceRequest diff --git a/core/wallet-core/testing/withdraw-testkudos.rst b/core/wallet-core/testing/withdraw-testkudos.rst @@ -6,16 +6,16 @@ **Request:** - This operation takes no arguments (an empty object). + This operation takes no arguments (an empty object). **Response:** - On success, the result is a `WithdrawTestBalanceResult` object. + On success, the result is a `WithdrawTestBalanceResult` object. **Side effects:** - Performs a real withdrawal at the test deployment over the network - and creates a withdrawal transaction in the wallet. + Performs a real withdrawal at the test deployment over the network + and creates a withdrawal transaction in the wallet. .. ts:def:: WithdrawTestBalanceResult diff --git a/core/wallet-core/tokens/delete-discount.rst b/core/wallet-core/tokens/delete-discount.rst @@ -4,22 +4,22 @@ **Request:** - The request arguments must be a `DeleteDiscountRequest` object. + The request arguments must be a `DeleteDiscountRequest` object. **Response:** - On success, the result is an empty object. + On success, the result is an empty object. **Side effects:** - Deletes all discount tokens of the token family from the wallet - database. If any token of the family is still in use by a - transaction, nothing is deleted. + Deletes all discount tokens of the token family from the wallet + database. If any token of the family is still in use by a + transaction, nothing is deleted. **Expected errors:** - The caller can handle the following errors inline: - ``WALLET_TOKENS_IN_USE``. + The caller can handle the following errors inline: + ``WALLET_TOKENS_IN_USE``. .. ts:def:: DeleteDiscountRequest diff --git a/core/wallet-core/tokens/delete-subscription.rst b/core/wallet-core/tokens/delete-subscription.rst @@ -4,22 +4,22 @@ **Request:** - The request arguments must be a `DeleteSubscriptionRequest` object. + The request arguments must be a `DeleteSubscriptionRequest` object. **Response:** - On success, the result is an empty object. + On success, the result is an empty object. **Side effects:** - Deletes all subscription tokens of the token family from the wallet - database. If any token of the family is still in use by a - transaction, nothing is deleted. + Deletes all subscription tokens of the token family from the wallet + database. If any token of the family is still in use by a + transaction, nothing is deleted. **Expected errors:** - The caller can handle the following errors inline: - ``WALLET_TOKENS_IN_USE``. + The caller can handle the following errors inline: + ``WALLET_TOKENS_IN_USE``. .. ts:def:: DeleteSubscriptionRequest diff --git a/core/wallet-core/tokens/list-discounts.rst b/core/wallet-core/tokens/list-discounts.rst @@ -7,12 +7,12 @@ **Request:** - The request arguments must be a `ListDiscountsRequest` object. - Omitted filter fields do not restrict the result. + The request arguments must be a `ListDiscountsRequest` object. + Omitted filter fields do not restrict the result. **Response:** - On success, the result is a `ListDiscountsResponse` object. + On success, the result is a `ListDiscountsResponse` object. .. ts:def:: ListDiscountsRequest diff --git a/core/wallet-core/tokens/list-subscriptions.rst b/core/wallet-core/tokens/list-subscriptions.rst @@ -7,12 +7,12 @@ **Request:** - The request arguments must be a `ListSubscriptionsRequest` object, - which has the same fields as `ListDiscountsRequest`. + The request arguments must be a `ListSubscriptionsRequest` object, + which has the same fields as `ListDiscountsRequest`. **Response:** - On success, the result is a `ListSubscriptionsResponse` object. + On success, the result is a `ListSubscriptionsResponse` object. .. ts:def:: ListSubscriptionsRequest diff --git a/core/wallet-core/transactions/abort-transaction.rst b/core/wallet-core/transactions/abort-transaction.rst @@ -4,32 +4,32 @@ **Request:** - The request ``args`` must be an `AbortTransactionRequest` object. + The request ``args`` must be an `AbortTransactionRequest` object. **Response:** - On success, the result is an empty object. + On success, the result is an empty object. **Side effects:** - Transitions the transaction into an aborting state and starts - abort processing, which may issue refunds or recover coins - (network activity). + Transitions the transaction into an aborting state and starts + abort processing, which may issue refunds or recover coins + (network activity). **Expected errors:** - The caller can handle the following errors inline: - ``WALLET_TRANSACTION_NOT_FOUND``, - ``WALLET_TRANSACTION_ACTION_UNSUPPORTED``, - ``WALLET_REQUEST_TRANSACTION_STATE_UNSUPPORTED``. + The caller can handle the following errors inline: + ``WALLET_TRANSACTION_NOT_FOUND``, + ``WALLET_TRANSACTION_ACTION_UNSUPPORTED``, + ``WALLET_REQUEST_TRANSACTION_STATE_UNSUPPORTED``. **Details:** - For payment transactions, aborting puts the payment into an - ``aborting`` state, in which the wallet recovers the spent coins - via a refund where possible before the transaction reaches a - final state. Whether a transaction can currently be aborted is - advertised in its ``txActions``. + For payment transactions, aborting puts the payment into an + ``aborting`` state, in which the wallet recovers the spent coins + via a refund where possible before the transaction reaches a + final state. Whether a transaction can currently be aborted is + advertised in its ``txActions``. .. ts:def:: AbortTransactionRequest diff --git a/core/wallet-core/transactions/delete-transaction.rst b/core/wallet-core/transactions/delete-transaction.rst @@ -5,27 +5,27 @@ **Request:** - The request ``args`` must be a `DeleteTransactionRequest` object. + The request ``args`` must be a `DeleteTransactionRequest` object. **Response:** - On success, the result is an empty object. + On success, the result is an empty object. **Side effects:** - Deletes the transaction from the wallet's history. + Deletes the transaction from the wallet's history. **Expected errors:** - The caller can handle the following errors inline: - ``WALLET_TRANSACTION_NOT_FOUND``, - ``WALLET_REQUEST_TRANSACTION_STATE_UNSUPPORTED``. + The caller can handle the following errors inline: + ``WALLET_TRANSACTION_NOT_FOUND``, + ``WALLET_REQUEST_TRANSACTION_STATE_UNSUPPORTED``. **Details:** - Deleting is only possible in states that advertise the ``delete`` - action (in ``txActions``), typically final or dialog states. Any - background task associated with the transaction is stopped. + Deleting is only possible in states that advertise the ``delete`` + action (in ``txActions``), typically final or dialog states. Any + background task associated with the transaction is stopped. .. ts:def:: DeleteTransactionRequest diff --git a/core/wallet-core/transactions/fail-transaction.rst b/core/wallet-core/transactions/fail-transaction.rst @@ -4,33 +4,33 @@ **Request:** - The request ``args`` must be a `FailTransactionRequest` object. + The request ``args`` must be a `FailTransactionRequest` object. **Response:** - On success, the result is an empty object. + On success, the result is an empty object. **Side effects:** - Marks an aborting transaction as finally failed, giving up on - the ongoing recovery. + Marks an aborting transaction as finally failed, giving up on + the ongoing recovery. **Expected errors:** - The caller can handle the following errors inline: - ``WALLET_TRANSACTION_NOT_FOUND``, - ``WALLET_TRANSACTION_ACTION_UNSUPPORTED``, - ``WALLET_REQUEST_TRANSACTION_STATE_UNSUPPORTED``. + The caller can handle the following errors inline: + ``WALLET_TRANSACTION_NOT_FOUND``, + ``WALLET_TRANSACTION_ACTION_UNSUPPORTED``, + ``WALLET_REQUEST_TRANSACTION_STATE_UNSUPPORTED``. **Details:** - This is typically used for transactions in an ``aborting`` state - (for example while recovering an aborted payment via a refund): - the user stops waiting for the recovery, and the transaction - transitions to the final ``failed`` state. The reason is - recorded in the transaction's ``failReason``. Whether a - transaction can currently be failed is advertised in its - ``txActions``. + This is typically used for transactions in an ``aborting`` state + (for example while recovering an aborted payment via a refund): + the user stops waiting for the recovery, and the transaction + transitions to the final ``failed`` state. The reason is + recorded in the transaction's ``failReason``. Whether a + transaction can currently be failed is advertised in its + ``txActions``. .. ts:def:: FailTransactionRequest diff --git a/core/wallet-core/transactions/get-transaction-by-id.rst b/core/wallet-core/transactions/get-transaction-by-id.rst @@ -5,27 +5,27 @@ **Request:** - The request ``args`` must be a `TransactionByIdRequest` object. + The request ``args`` must be a `TransactionByIdRequest` object. **Response:** - On success, the result is a `Transaction` object. + On success, the result is a `Transaction` object. **Expected errors:** - The caller can handle the following errors inline: - ``WALLET_TRANSACTION_NOT_FOUND``, ``WALLET_CORE_API_BAD_REQUEST``. + The caller can handle the following errors inline: + ``WALLET_TRANSACTION_NOT_FOUND``, ``WALLET_CORE_API_BAD_REQUEST``. **Details:** - The ``transactionId`` must have the form of a `TransactionIdStr`; - malformed identifiers fail with ``WALLET_CORE_API_BAD_REQUEST``, - well-formed but unknown identifiers with - ``WALLET_TRANSACTION_NOT_FOUND``. + The ``transactionId`` must have the form of a `TransactionIdStr`; + malformed identifiers fail with ``WALLET_CORE_API_BAD_REQUEST``, + well-formed but unknown identifiers with + ``WALLET_TRANSACTION_NOT_FOUND``. - The full contract terms (``contractTerms``) are only reported for - payment transactions and only when ``includeContractTerms`` is - set. + The full contract terms (``contractTerms``) are only reported for + payment transactions and only when ``includeContractTerms`` is + set. .. ts:def:: Transaction diff --git a/core/wallet-core/transactions/get-transactions-v2.rst b/core/wallet-core/transactions/get-transactions-v2.rst @@ -6,35 +6,35 @@ **Request:** - The request ``args`` must be a `GetTransactionsV2Request` object. + The request ``args`` must be a `GetTransactionsV2Request` object. **Response:** - On success, the result is a `TransactionsResponse` object. + On success, the result is a `TransactionsResponse` object. **Details:** - Without a ``limit`` and without an offset, all matching - transactions are returned in ascending timestamp order. - - With a positive ``limit``, at most ``limit`` transactions are - returned in ascending order: without an offset starting at the - first transaction, with an offset starting after the offset. With - a negative ``limit``, at most ``-limit`` transactions are returned - in descending order: without an offset starting at the last - transaction, with an offset starting before the offset. - Transactions with equal timestamps are ordered by their - ``transactionId``. - - If the ``offsetTransactionId`` no longer exists (for example - because the transaction was deleted), ``offsetTimestamp`` is used - as a fallback anchor. If the offset transaction does not exist - and no ``offsetTimestamp`` is given, the request fails with - ``WALLET_TRANSACTION_NOT_FOUND``. - - Refresh transactions are excluded unless ``includeRefreshes`` (or - ``includeAll``) is set; payments that were superseded by a - repurchase are excluded unless ``includeAll`` is set. + Without a ``limit`` and without an offset, all matching + transactions are returned in ascending timestamp order. + + With a positive ``limit``, at most ``limit`` transactions are + returned in ascending order: without an offset starting at the + first transaction, with an offset starting after the offset. With + a negative ``limit``, at most ``-limit`` transactions are returned + in descending order: without an offset starting at the last + transaction, with an offset starting before the offset. + Transactions with equal timestamps are ordered by their + ``transactionId``. + + If the ``offsetTransactionId`` no longer exists (for example + because the transaction was deleted), ``offsetTimestamp`` is used + as a fallback anchor. If the offset transaction does not exist + and no ``offsetTimestamp`` is given, the request fails with + ``WALLET_TRANSACTION_NOT_FOUND``. + + Refresh transactions are excluded unless ``includeRefreshes`` (or + ``includeAll``) is set; payments that were superseded by a + repurchase are excluded unless ``includeAll`` is set. .. ts:def:: GetTransactionsV2Request diff --git a/core/wallet-core/transactions/get-transactions.rst b/core/wallet-core/transactions/get-transactions.rst @@ -6,27 +6,27 @@ **Request:** - The request ``args`` must be a `TransactionsRequest` object. + The request ``args`` must be a `TransactionsRequest` object. **Response:** - On success, the result is a `TransactionsResponse` object. + On success, the result is a `TransactionsResponse` object. **Details:** - Refresh transactions are excluded from the result unless - ``includeRefreshes`` is set. + Refresh transactions are excluded from the result unless + ``includeRefreshes`` is set. - With the default sort orders (``ascending`` and ``descending``), - pending transactions (major states ``pending``, ``aborting`` and - ``dialog``) are listed before all other transactions; within each - group, transactions are sorted by their timestamp, and ties are - broken by a fixed transaction-type order. With - ``stable-ascending``, all transactions are sorted purely by - ascending timestamp, so pending transactions do not jump around. + With the default sort orders (``ascending`` and ``descending``), + pending transactions (major states ``pending``, ``aborting`` and + ``dialog``) are listed before all other transactions; within each + group, transactions are sorted by their timestamp, and ties are + broken by a fixed transaction-type order. With + ``stable-ascending``, all transactions are sorted purely by + ascending timestamp, so pending transactions do not jump around. - Filtering by an auditor scope (``scopeInfo`` of type ``auditor``) - is not supported and fails with ``WALLET_CORE_API_BAD_REQUEST``. + Filtering by an auditor scope (``scopeInfo`` of type ``auditor``) + is not supported and fails with ``WALLET_CORE_API_BAD_REQUEST``. .. ts:def:: TransactionsRequest diff --git a/core/wallet-core/transactions/list-associated-refreshes.rst b/core/wallet-core/transactions/list-associated-refreshes.rst @@ -7,13 +7,13 @@ **Request:** - The request ``args`` must be a `ListAssociatedRefreshesRequest` - object. + The request ``args`` must be a `ListAssociatedRefreshesRequest` + object. **Response:** - On success, the result is a `ListAssociatedRefreshesResponse` - object. + On success, the result is a `ListAssociatedRefreshesResponse` + object. .. ts:def:: ListAssociatedRefreshesRequest diff --git a/core/wallet-core/transactions/resolve-transaction-reference.rst b/core/wallet-core/transactions/resolve-transaction-reference.rst @@ -6,34 +6,34 @@ **Request:** - The request ``args`` must be a `ResolveTransactionReferenceRequest` - object. + The request ``args`` must be a `ResolveTransactionReferenceRequest` + object. **Response:** - On success, the result is a `ResolveTransactionReferenceResponse` - object. + On success, the result is a `ResolveTransactionReferenceResponse` + object. **Expected errors:** - The caller can handle the following errors inline: - ``WALLET_TRANSACTION_NOT_FOUND``, ``WALLET_CORE_API_BAD_REQUEST``. + The caller can handle the following errors inline: + ``WALLET_TRANSACTION_NOT_FOUND``, ``WALLET_CORE_API_BAD_REQUEST``. **Details:** - Three kinds of references are accepted: - - * a stable transaction ID (`TransactionIdStr`), which is returned - unchanged; - * a wallet-local identifier of the form ``#<type>:<localIdent>``, - as reported in the transaction's ``localTransactionId`` field. - Local identifiers are deliberately not portable: importing or - merging a wallet can assign different local identifiers; - * an external, bank-generated withdrawal reference (such as an - LSD 0006 withdrawal-transfer-result reference) that contains - the reserve public key of a withdrawal. The reference must - match exactly one withdrawal transaction, otherwise the request - fails with ``WALLET_TRANSACTION_NOT_FOUND``. + Three kinds of references are accepted: + + * a stable transaction ID (`TransactionIdStr`), which is returned + unchanged; + * a wallet-local identifier of the form ``#<type>:<localIdent>``, + as reported in the transaction's ``localTransactionId`` field. + Local identifiers are deliberately not portable: importing or + merging a wallet can assign different local identifiers; + * an external, bank-generated withdrawal reference (such as an + LSD 0006 withdrawal-transfer-result reference) that contains + the reserve public key of a withdrawal. The reference must + match exactly one withdrawal transaction, otherwise the request + fails with ``WALLET_TRANSACTION_NOT_FOUND``. .. ts:def:: ResolveTransactionReferenceRequest diff --git a/core/wallet-core/transactions/resume-transaction.rst b/core/wallet-core/transactions/resume-transaction.rst @@ -5,20 +5,20 @@ **Request:** - The request ``args`` must be an `AbortTransactionRequest` object. + The request ``args`` must be an `AbortTransactionRequest` object. **Response:** - On success, the result is an empty object. + On success, the result is an empty object. **Side effects:** - Resumes a suspended transaction; its processing restarts, - possibly with network activity. + Resumes a suspended transaction; its processing restarts, + possibly with network activity. **Expected errors:** - The caller can handle the following errors inline: - ``WALLET_TRANSACTION_NOT_FOUND``, - ``WALLET_TRANSACTION_ACTION_UNSUPPORTED``, - ``WALLET_REQUEST_TRANSACTION_STATE_UNSUPPORTED``. + The caller can handle the following errors inline: + ``WALLET_TRANSACTION_NOT_FOUND``, + ``WALLET_TRANSACTION_ACTION_UNSUPPORTED``, + ``WALLET_REQUEST_TRANSACTION_STATE_UNSUPPORTED``. diff --git a/core/wallet-core/transactions/retry-transaction.rst b/core/wallet-core/transactions/retry-transaction.rst @@ -5,28 +5,28 @@ **Request:** - The request ``args`` must be a `RetryTransactionRequest` object. + The request ``args`` must be a `RetryTransactionRequest` object. **Response:** - On success, the result is an empty object. + On success, the result is an empty object. **Side effects:** - Immediately retries processing of the transaction; network - activity is possible. + Immediately retries processing of the transaction; network + activity is possible. **Expected errors:** - The caller can handle the following errors inline: - ``WALLET_TRANSACTION_NOT_FOUND``, - ``WALLET_REQUEST_TRANSACTION_STATE_UNSUPPORTED``. + The caller can handle the following errors inline: + ``WALLET_TRANSACTION_NOT_FOUND``, + ``WALLET_REQUEST_TRANSACTION_STATE_UNSUPPORTED``. **Details:** - Retrying is only possible in states that advertise the ``retry`` - action (in ``txActions``); the request does not wait for the - retried operation to complete. + Retrying is only possible in states that advertise the ``retry`` + action (in ``txActions``); the request does not wait for the + retried operation to complete. .. ts:def:: RetryTransactionRequest diff --git a/core/wallet-core/transactions/suspend-transaction.rst b/core/wallet-core/transactions/suspend-transaction.rst @@ -7,19 +7,19 @@ **Request:** - The request ``args`` must be an `AbortTransactionRequest` object. + The request ``args`` must be an `AbortTransactionRequest` object. **Response:** - On success, the result is an empty object. + On success, the result is an empty object. **Side effects:** - Suspends a pending transaction; its processing stops. + Suspends a pending transaction; its processing stops. **Expected errors:** - The caller can handle the following errors inline: - ``WALLET_TRANSACTION_NOT_FOUND``, - ``WALLET_TRANSACTION_ACTION_UNSUPPORTED``, - ``WALLET_REQUEST_TRANSACTION_STATE_UNSUPPORTED``. + The caller can handle the following errors inline: + ``WALLET_TRANSACTION_NOT_FOUND``, + ``WALLET_TRANSACTION_ACTION_UNSUPPORTED``, + ``WALLET_REQUEST_TRANSACTION_STATE_UNSUPPORTED``. diff --git a/core/wallet-core/transactions/wait-transaction-state.rst b/core/wallet-core/transactions/wait-transaction-state.rst @@ -7,49 +7,49 @@ **Request:** - The request ``args`` must be a `WaitTransactionStateRequest` - object. + The request ``args`` must be a `WaitTransactionStateRequest` + object. **Response:** - On success, the result is a `WaitTransactionStateResponse` - object. + On success, the result is a `WaitTransactionStateResponse` + object. **Details:** - This is a long-polling operation: it returns once the - transaction's state matches ``txState``, matches one of the - ``bailStates``, or (with ``bailOnError``) an error is recorded - for the transaction. The response's ``matched`` field says which - of the two sets of states ended the wait. - - The ``txState`` and ``bailStates`` fields are - `TestingWaitTxStateSpec` values: a `TransactionStatePattern` or a - list of patterns (matching when any pattern matches), a - wallet-internal numeric state ID, or one of the shorthands - ``nonpending`` (any major state other than ``pending``) and - ``final`` (any final major state). In a pattern, ``major``, - ``minor`` and ``working`` accept the wildcard ``*``; a pattern - without ``minor`` only matches states that have no minor state, - while a pattern without ``working`` matches regardless of the - flag. - - Without ``bailStates`` or ``bailOnError``, a transaction that - reaches a state it will never leave keeps the caller waiting - until the ``timeout`` expires; the wait then fails with - ``GENERIC_TIMEOUT``. - - If no transaction with the given ``transactionId`` exists, the - wait fails with ``WALLET_TRANSACTION_NOT_FOUND`` instead of - waiting. - - When ``progressToken`` is set, the wait reports request - progress notifications (including recorded transaction errors - with their retry counter and remaining retry delay) and can be - cancelled with :ts:op:`cancelProgressToken` or nudged with - :ts:op:`retryProgressTokenNow`. Cancellation fails the wait - with ``WALLET_CORE_REQUEST_CANCELLED``; it stops only the wait, - not the transaction. + This is a long-polling operation: it returns once the + transaction's state matches ``txState``, matches one of the + ``bailStates``, or (with ``bailOnError``) an error is recorded + for the transaction. The response's ``matched`` field says which + of the two sets of states ended the wait. + + The ``txState`` and ``bailStates`` fields are + `TestingWaitTxStateSpec` values: a `TransactionStatePattern` or a + list of patterns (matching when any pattern matches), a + wallet-internal numeric state ID, or one of the shorthands + ``nonpending`` (any major state other than ``pending``) and + ``final`` (any final major state). In a pattern, ``major``, + ``minor`` and ``working`` accept the wildcard ``*``; a pattern + without ``minor`` only matches states that have no minor state, + while a pattern without ``working`` matches regardless of the + flag. + + Without ``bailStates`` or ``bailOnError``, a transaction that + reaches a state it will never leave keeps the caller waiting + until the ``timeout`` expires; the wait then fails with + ``GENERIC_TIMEOUT``. + + If no transaction with the given ``transactionId`` exists, the + wait fails with ``WALLET_TRANSACTION_NOT_FOUND`` instead of + waiting. + + When ``progressToken`` is set, the wait reports request + progress notifications (including recorded transaction errors + with their retry counter and remaining retry delay) and can be + cancelled with :ts:op:`cancelProgressToken` or nudged with + :ts:op:`retryProgressTokenNow`. Cancellation fails the wait + with ``WALLET_CORE_REQUEST_CANCELLED``; it stops only the wait, + not the transaction. .. ts:def:: WaitTransactionStateRequest diff --git a/core/wallet-core/validation/canonicalize-base-url.rst b/core/wallet-core/validation/canonicalize-base-url.rst @@ -6,18 +6,18 @@ **Request:** - The request must be a `CanonicalizeBaseUrlRequest` object. + The request must be a `CanonicalizeBaseUrlRequest` object. **Response:** - On success, the result is a `CanonicalizeBaseUrlResponse` - object. + On success, the result is a `CanonicalizeBaseUrlResponse` + object. **Details:** - An ``https://`` scheme is prepended when the URL has no scheme, - a trailing slash is appended to the path when missing, and any - query and fragment are removed. + An ``https://`` scheme is prepended when the URL has no scheme, + a trailing slash is appended to the path when missing, and any + query and fragment are removed. .. ts:def:: CanonicalizeBaseUrlRequest diff --git a/core/wallet-core/validation/convert-iban-account-field-to-payto.rst b/core/wallet-core/validation/convert-iban-account-field-to-payto.rst @@ -6,21 +6,21 @@ **Request:** - The request must be a `ConvertIbanAccountFieldToPaytoRequest` - object. + The request must be a `ConvertIbanAccountFieldToPaytoRequest` + object. **Response:** - On success, the result is a - `ConvertIbanAccountFieldToPaytoResponse` object. + On success, the result is a + `ConvertIbanAccountFieldToPaytoResponse` object. **Details:** - Dashes and spaces are stripped from the input. For ``HUF``, - the input is treated as a Hungarian BBAN and converted to an - IBAN (a developer experiment enables the same conversion for - Swiss BBANs); for other currencies, the input must be a valid - IBAN. When the input cannot be converted, ``ok`` is ``false``. + Dashes and spaces are stripped from the input. For ``HUF``, + the input is treated as a Hungarian BBAN and converted to an + IBAN (a developer experiment enables the same conversion for + Swiss BBANs); for other currencies, the input must be a valid + IBAN. When the input cannot be converted, ``ok`` is ``false``. .. ts:def:: ConvertIbanAccountFieldToPaytoRequest diff --git a/core/wallet-core/validation/convert-iban-payto-to-account-field.rst b/core/wallet-core/validation/convert-iban-payto-to-account-field.rst @@ -6,20 +6,20 @@ **Request:** - The request must be a `ConvertIbanPaytoToAccountFieldRequest` - object. + The request must be a `ConvertIbanPaytoToAccountFieldRequest` + object. **Response:** - On success, the result is a - `ConvertIbanPaytoToAccountFieldResponse` object. + On success, the result is a + `ConvertIbanPaytoToAccountFieldResponse` object. **Details:** - Hungarian IBANs are converted to the domestic BBAN form (a - developer experiment enables the same conversion for Swiss - IBANs); all other IBANs are returned unchanged. An error is - thrown when ``paytoUri`` is not a valid payto URI. + Hungarian IBANs are converted to the domestic BBAN form (a + developer experiment enables the same conversion for Swiss + IBANs); all other IBANs are returned unchanged. An error is + thrown when ``paytoUri`` is not a valid payto URI. .. ts:def:: ConvertIbanPaytoToAccountFieldRequest diff --git a/core/wallet-core/validation/get-banking-choices-for-payto.rst b/core/wallet-core/validation/get-banking-choices-for-payto.rst @@ -6,21 +6,21 @@ **Request:** - The request must be a `GetBankingChoicesForPaytoRequest` - object. + The request must be a `GetBankingChoicesForPaytoRequest` + object. **Response:** - On success, the result is a `GetBankingChoicesForPaytoResponse` - object. + On success, the result is a `GetBankingChoicesForPaytoResponse` + object. **Details:** - Currently, choices are only returned for the ``KUDOS`` - demonstration currency (links to the demonstrator bank's - website and app); the list is empty when the payto URI carries - no amount or no choice is known for the currency. An error is - thrown when ``paytoUri`` is not a valid payto URI. + Currently, choices are only returned for the ``KUDOS`` + demonstration currency (links to the demonstrator bank's + website and app); the list is empty when the payto URI carries + no amount or no choice is known for the currency. An error is + thrown when ``paytoUri`` is not a valid payto URI. .. ts:def:: GetBankingChoicesForPaytoRequest diff --git a/core/wallet-core/validation/get-qr-codes-for-payto.rst b/core/wallet-core/validation/get-qr-codes-for-payto.rst @@ -10,18 +10,18 @@ **Request:** - The request must be a `GetQrCodesForPaytoRequest` object. + The request must be a `GetQrCodesForPaytoRequest` object. **Response:** - On success, the result is a `GetQrCodesForPaytoResponse` - object. + On success, the result is a `GetQrCodesForPaytoResponse` + object. **Details:** - All applicable QR code specifications are returned (an EPC QR - code and/or a Swiss QR bill); the list is empty when none - applies to the given payto URI. + All applicable QR code specifications are returned (an EPC QR + code and/or a Swiss QR bill); the list is empty when none + applies to the given payto URI. .. ts:def:: GetQrCodesForPaytoRequest diff --git a/core/wallet-core/validation/validate-iban.rst b/core/wallet-core/validation/validate-iban.rst @@ -6,11 +6,11 @@ **Request:** - The request must be a `ValidateIbanRequest` object. + The request must be a `ValidateIbanRequest` object. **Response:** - On success, the result is a `ValidateIbanResponse` object. + On success, the result is a `ValidateIbanResponse` object. .. ts:def:: ValidateIbanRequest