From 58e7b0094e52316066fd7f1ba806859ed006f1d2 Mon Sep 17 00:00:00 2001 From: Christian Grothoff Date: Sun, 21 Aug 2022 21:30:53 +0200 Subject: -unify titles --- design-documents/001-new-browser-integration.rst | 4 +-- .../002-wallet-exchange-management.rst | 4 +-- design-documents/003-tos-rendering.rst | 4 +-- design-documents/004-wallet-withdrawal-flow.rst | 4 +-- design-documents/005-wallet-backup-sync.rst | 8 +++--- design-documents/006-extensions.rst | 12 ++++----- design-documents/007-payment.rst | 4 +-- design-documents/008-fees.rst | 4 +-- design-documents/009-backup.rst | 4 +-- design-documents/010-exchange-helpers.rst | 4 +-- design-documents/011-auditor-db-sync.rst | 4 +-- design-documents/012-fee-schedule-metrics.rst | 4 +-- design-documents/013-peer-to-peer-payments.rst | 8 +++--- design-documents/014-merchant-backoffice-ui.rst | 4 +-- .../015-merchant-backoffice-routing.rst | 4 +-- .../016-backoffice-order-management.rst | 4 +-- .../017-backoffice-inventory-management.rst | 20 ++++++--------- design-documents/018-contract-json.rst | 4 +-- design-documents/019-wallet-backup-merge.rst | 4 +-- .../020-backoffice-tips-management.rst | 6 ++--- design-documents/021-exchange-key-continuity.rst | 4 +-- design-documents/023-taler-kyc.rst | 4 +-- design-documents/024-age-restriction.rst | 29 +++++++++++----------- design-documents/025-withdraw-from-wallet.rst | 11 +++----- design-documents/026-refund-fees.rst | 4 +-- design-documents/027-sandboxing-taler.rst | 4 +-- design-documents/028-proof-of-escrow.rst | 4 +-- design-documents/029-mobile-ui.rst | 8 +++--- design-documents/030-offline-payments.rst | 4 +-- design-documents/031-invoicing.rst | 4 +-- design-documents/032-auctions.rst | 4 +-- 31 files changed, 91 insertions(+), 103 deletions(-) diff --git a/design-documents/001-new-browser-integration.rst b/design-documents/001-new-browser-integration.rst index 8dbe2a43..80a08859 100644 --- a/design-documents/001-new-browser-integration.rst +++ b/design-documents/001-new-browser-integration.rst @@ -1,5 +1,5 @@ -Design Doc 001: New Browser Integration -####################################### +DD1: New Browser Integration +############################ .. warning:: diff --git a/design-documents/002-wallet-exchange-management.rst b/design-documents/002-wallet-exchange-management.rst index 18015916..297c23f8 100644 --- a/design-documents/002-wallet-exchange-management.rst +++ b/design-documents/002-wallet-exchange-management.rst @@ -1,5 +1,5 @@ -Design Doc 002: Wallet Exchange Management -########################################## +DD2: Wallet Exchange Management +############################### .. note:: diff --git a/design-documents/003-tos-rendering.rst b/design-documents/003-tos-rendering.rst index 3011775c..9b19ee02 100644 --- a/design-documents/003-tos-rendering.rst +++ b/design-documents/003-tos-rendering.rst @@ -1,5 +1,5 @@ -Design Doc 003: ToS rendering -############################# +DD3: ToS rendering +################## Summary ======= diff --git a/design-documents/004-wallet-withdrawal-flow.rst b/design-documents/004-wallet-withdrawal-flow.rst index 28e9c16b..a385959b 100644 --- a/design-documents/004-wallet-withdrawal-flow.rst +++ b/design-documents/004-wallet-withdrawal-flow.rst @@ -1,5 +1,5 @@ -Design Doc 004: Wallet Withdrawal Flow -###################################### +DD4: Wallet Withdrawal Flow +########################### Summary ======= diff --git a/design-documents/005-wallet-backup-sync.rst b/design-documents/005-wallet-backup-sync.rst index 20fce37b..7592242c 100644 --- a/design-documents/005-wallet-backup-sync.rst +++ b/design-documents/005-wallet-backup-sync.rst @@ -1,5 +1,5 @@ -Design Doc 005: Wallet Backup and Sync -###################################### +DD5: Wallet Backup and Sync +########################### .. warning:: @@ -56,13 +56,13 @@ Entities that are **not** synchronized are: * withdrawal operations before they have been accepted by the user Entities that **could** be synchronized (to be decided): - + * private keys of other sync accounts * coin planchets * tips before the corresponding coins have been withdrawn * refresh sessions (not only the "meta data" about the operation, but everything) - + Garbage collection ------------------ diff --git a/design-documents/006-extensions.rst b/design-documents/006-extensions.rst index 42a0e575..576809ad 100644 --- a/design-documents/006-extensions.rst +++ b/design-documents/006-extensions.rst @@ -1,5 +1,5 @@ -Design Doc 006: Extensions for GNU Taler -############################################# +DD6: Extensions for GNU Taler +############################# Summary ======= @@ -84,7 +84,7 @@ Extension object ---------------- The definition of ``Extension`` object itself is mostly up to the particular -feature. **However**, it MUST have +feature. **However**, it MUST have #. the boolean field ``critical`` that has the same semantics as as "critical" has for extensions in X.509_: if true, the client must "understand" the @@ -93,7 +93,7 @@ feature. **However**, it MUST have #. the field ``version`` of type `LibtoolVersion` which contains the version information of the extension in Taler's `protocol version ranges notation`_. - + .. _X.509: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2 .. _`protocol version ranges notation`: https://docs.taler.net/core/api-common.html#protocol-version-ranges @@ -150,7 +150,7 @@ object MUST be signed by the exchange's master signing key. Whenever extensions are enabled or disabled, the offline tool MUST sign the SHA256 hash of the normalized JSON-string of the ``extensions`` object, if it is not empty. -In order to do so, the ``taler-exchange-offline`` tool MUST +In order to do so, the ``taler-exchange-offline`` tool MUST #. have the complete list of all available optional features/extensions and their versions builtin and @@ -209,5 +209,3 @@ Discussion / Q&A The initial ideas presented here are based on discussions between Özgür Kesim and Christian Grothoff. - - diff --git a/design-documents/007-payment.rst b/design-documents/007-payment.rst index 115ac3f8..2750c816 100644 --- a/design-documents/007-payment.rst +++ b/design-documents/007-payment.rst @@ -1,5 +1,5 @@ -Design Doc 007: Specification of the Payment Flow -################################################# +DD7: Specification of the Payment Flow +###################################### Summary ======= diff --git a/design-documents/008-fees.rst b/design-documents/008-fees.rst index 47c2af8a..b99190c4 100644 --- a/design-documents/008-fees.rst +++ b/design-documents/008-fees.rst @@ -1,5 +1,5 @@ -Design Doc 008: Fee Structure Metrics -##################################### +DD8: Fee Structure Metrics +########################## .. note:: diff --git a/design-documents/009-backup.rst b/design-documents/009-backup.rst index 04ae628c..1cf9bb23 100644 --- a/design-documents/009-backup.rst +++ b/design-documents/009-backup.rst @@ -1,5 +1,5 @@ -Design Doc 009: Wallet Backup -############################# +DD9: Wallet Backup +################## Summary ======= diff --git a/design-documents/010-exchange-helpers.rst b/design-documents/010-exchange-helpers.rst index a12b4a20..fe9de063 100644 --- a/design-documents/010-exchange-helpers.rst +++ b/design-documents/010-exchange-helpers.rst @@ -1,5 +1,5 @@ -Design Doc 010: Exchange crypto helper design -############################################# +DD10: Exchange crypto helper design +################################### Summary ======= diff --git a/design-documents/011-auditor-db-sync.rst b/design-documents/011-auditor-db-sync.rst index d49503d2..8a460ed8 100644 --- a/design-documents/011-auditor-db-sync.rst +++ b/design-documents/011-auditor-db-sync.rst @@ -1,5 +1,5 @@ -Design Doc 011: Auditor-Exchange Database Synchronization -######################################################### +DD11: Auditor-Exchange Database Synchronization +############################################### Summary ======= diff --git a/design-documents/012-fee-schedule-metrics.rst b/design-documents/012-fee-schedule-metrics.rst index 031783cd..3ab7f565 100644 --- a/design-documents/012-fee-schedule-metrics.rst +++ b/design-documents/012-fee-schedule-metrics.rst @@ -1,5 +1,5 @@ -Design Doc 012: Exchange Fee Configuration -########################################## +DD12: Exchange Fee Configuration +################################ .. note:: diff --git a/design-documents/013-peer-to-peer-payments.rst b/design-documents/013-peer-to-peer-payments.rst index 5c0d7d12..951f7f81 100644 --- a/design-documents/013-peer-to-peer-payments.rst +++ b/design-documents/013-peer-to-peer-payments.rst @@ -1,5 +1,5 @@ -Design Doc 013: Wallet-to-Wallet Payments -######################################### +DD13: Wallet-to-Wallet Payments +############################### Summary ======= @@ -1067,7 +1067,7 @@ Aside from implementation complexity, the solution has the following drawbacks: as the wallet software can trivially ensure that a backup was made of the account private key before initiating the KYC process. - + Refinements =========== @@ -1093,7 +1093,7 @@ signing the contract with the PurseContractKey and the merge with the PurseMergeKey would still work. Only the public PurseContractKey would need to be sent to the payer. - + Q / A ===== diff --git a/design-documents/014-merchant-backoffice-ui.rst b/design-documents/014-merchant-backoffice-ui.rst index 8c4104dc..63c326cc 100644 --- a/design-documents/014-merchant-backoffice-ui.rst +++ b/design-documents/014-merchant-backoffice-ui.rst @@ -1,5 +1,5 @@ -Design Doc 014: Merchant backoffice UI -###################################### +DD14: Merchant backoffice UI +############################ Motivation diff --git a/design-documents/015-merchant-backoffice-routing.rst b/design-documents/015-merchant-backoffice-routing.rst index 7362642e..e5110bee 100644 --- a/design-documents/015-merchant-backoffice-routing.rst +++ b/design-documents/015-merchant-backoffice-routing.rst @@ -1,5 +1,5 @@ -Design Doc 015: Merchant backoffice Routing -########################################### +DD15: Merchant backoffice Routing +################################# Motivation diff --git a/design-documents/016-backoffice-order-management.rst b/design-documents/016-backoffice-order-management.rst index deaf7170..e2fca0fe 100644 --- a/design-documents/016-backoffice-order-management.rst +++ b/design-documents/016-backoffice-order-management.rst @@ -1,5 +1,5 @@ -Design Doc 016: Backoffice Order Management -########################################### +DD16: Backoffice Order Management +################################# Summary ======= diff --git a/design-documents/017-backoffice-inventory-management.rst b/design-documents/017-backoffice-inventory-management.rst index b2fc6dfd..30a6d835 100644 --- a/design-documents/017-backoffice-inventory-management.rst +++ b/design-documents/017-backoffice-inventory-management.rst @@ -1,5 +1,5 @@ -Design Doc 017: Backoffice Inventory Management -############################################### +DD17: Backoffice Inventory Management +##################################### Summary ======= @@ -55,7 +55,7 @@ Create and Update Product form .. image:: ../backoffice-product-create.svg :width: 800 - + Update product will use the same form except for the ``product_id`` * product_id: BACKOFFICE_URL + id @@ -64,7 +64,7 @@ Update product will use the same form except for the ``product_id`` * name: required, one line * extra: optional, free text area -* description localized: list with +* description localized: list with * lang: dropdown list with supported lang + custom * description: text area @@ -95,7 +95,7 @@ Stock management * ``never`` button will set next restock to never -* when updating the product, the option ``without stock`` will no be available +* when updating the product, the option ``without stock`` will no be available if the product already has stock * if the product already exist then: @@ -119,7 +119,7 @@ Alternatives ============ * price and stock columns in the list can be merged into a more complex column - with the same information + with the same information * rows in the table can be expandable when clicked to get access to some common actions like increase stock or change price @@ -128,7 +128,7 @@ Alternatives :width: 800 * detail page was intentionally left out since all information can be access - from the update page + from the update page Q&A === @@ -138,8 +138,4 @@ Q&A * can we allow add extra data like order has in contractTerm?, this could be useful for frontend apps. example of usage: country/state to where the product - is sold since taxes may vary - - - - + is sold since taxes may vary diff --git a/design-documents/018-contract-json.rst b/design-documents/018-contract-json.rst index 3c9258a4..f930bcbd 100644 --- a/design-documents/018-contract-json.rst +++ b/design-documents/018-contract-json.rst @@ -1,5 +1,5 @@ -Design Doc 018: Forgettable Data in JSON Contract Terms -####################################################### +DD18: Forgettable Data in JSON Contract Terms +############################################# Summary ======= diff --git a/design-documents/019-wallet-backup-merge.rst b/design-documents/019-wallet-backup-merge.rst index caf45401..f716c7ba 100644 --- a/design-documents/019-wallet-backup-merge.rst +++ b/design-documents/019-wallet-backup-merge.rst @@ -1,5 +1,5 @@ -Design Doc 019: Wallet Backup Merging -##################################### +DD19: Wallet Backup Merging +########################### Summary ======= diff --git a/design-documents/020-backoffice-tips-management.rst b/design-documents/020-backoffice-tips-management.rst index 566f8fb5..6049109e 100644 --- a/design-documents/020-backoffice-tips-management.rst +++ b/design-documents/020-backoffice-tips-management.rst @@ -1,5 +1,5 @@ -Design Doc 020: Backoffice Tips Management -########################################## +DD20: Backoffice Tips Management +################################ Summary ======= @@ -93,5 +93,3 @@ When the reserve has not yet funded .. image:: ../backoffice-reserve-details.unfunded.svg :width: 400 - - diff --git a/design-documents/021-exchange-key-continuity.rst b/design-documents/021-exchange-key-continuity.rst index e09b6fe0..877ffdf8 100644 --- a/design-documents/021-exchange-key-continuity.rst +++ b/design-documents/021-exchange-key-continuity.rst @@ -1,5 +1,5 @@ -Design Doc 021: Exchange Key Continuity -####################################### +DD21: Exchange Key Continuity +############################# Summary ======= diff --git a/design-documents/023-taler-kyc.rst b/design-documents/023-taler-kyc.rst index fe855521..410c4d85 100644 --- a/design-documents/023-taler-kyc.rst +++ b/design-documents/023-taler-kyc.rst @@ -1,5 +1,5 @@ -DD 023: Taler KYC -################# +DD23: Taler KYC +############### Summary ======= diff --git a/design-documents/024-age-restriction.rst b/design-documents/024-age-restriction.rst index 0b3aa76f..6b1004fc 100644 --- a/design-documents/024-age-restriction.rst +++ b/design-documents/024-age-restriction.rst @@ -1,5 +1,5 @@ -DD 024: Anonymous Age Restriction Extension for GNU Taler -######################################################### +DD24: Anonymous Age Restriction Extension for GNU Taler +####################################################### Summary ======= @@ -18,7 +18,7 @@ sensitive private information is disclosed. We want to offer a better mechanism for age-restriction with GNU Taler that * ensures anonymity and unlinkability of purchases -* can be set to particular age groups by parents/wardens at withdrawal +* can be set to particular age groups by parents/wardens at withdrawal * is bound to particular coins/tokens * can be verified by the merchant at purchase time * persists even after refresh @@ -264,15 +264,15 @@ The schema for the exchange is changed as follows: BEGIN; -- Check patch versioning is in place. SELECT _v.register_patch('exchange-TBD', NULL, NULL); - + -- Support for age restriction is marked per denomination. ALTER TABLE denominations ADD COLUMN age_restricted BOOLEAN NOT NULL DEFAULT (false); COMMENT ON COLUMN denominations.age_restriced IS 'true if this denomination can be used for age restriction'; - -- During the melting phase of the refresh, the wallet has to present the - -- hash value of the age commitment (only for denominations with support + -- During the melting phase of the refresh, the wallet has to present the + -- hash value of the age commitment (only for denominations with support -- for age restriction). ALTER TABLE refresh_commitments ADD COLUMN age_commitment_h BYTEA CHECK (LENGTH(age_commitment_h)=64); @@ -306,7 +306,7 @@ restriction). Therefore, in the ``/coins/$COIN_PUB/melt`` POST request, the // SHA256 hash of the age commitment of the coin, IFF the denomination // has age restriction support. MUST be omitted otherwise. age_commitment_hash?: AgeCommitmentHash; - + ... } @@ -317,7 +317,7 @@ restriction). Therefore, in the ``/coins/$COIN_PUB/melt`` POST request, the The responses to the POST request remain the same. For normal denominations *without* support for age restriction, the calculation -for the signature check is as before (borrowing notation from +for the signature check is as before (borrowing notation from `Florian's thesis `_): .. math:: @@ -348,7 +348,7 @@ the amount of age groups defined in the field ``.age_groups`` of the ``ExtensionAgeRestriction``. .. ts:def:: RevealRequest - + interface RevealRequest { ... @@ -360,7 +360,7 @@ the amount of age groups defined in the field ``.age_groups`` of the // ``ExtensionAgeRestriction``. old_age_commitment?: Edx25519PublicKey[]; - + ... } @@ -379,7 +379,7 @@ exchange derives κ-1 age commitments from the ``old_age_commitment`` by calling as the seed, and then calculates the corresponding κ-1 hash values :math:`h_i` of those age commitments. -It then calculates the κ-1 blinded hashes +It then calculates the κ-1 blinded hashes :math:`m_i = r^{e_i}\text{FDH}_N(C^{(i)}_p, h_i)` (using the notation from Florian's thesis) of the disclosed coins and together with the :math:`m_\gamma` of the undisclosed coin, calculates the hash @@ -443,7 +443,7 @@ this value will not be smaller than, say, 8, and not larger than, say, 21. interface ContractTerms { ... - + // If the order requires a minimum age greater than 0, this field is set // to the integer value of that age. In reality this value will not be // smaller than, say, 8, and not larger than, say, 21. @@ -518,11 +518,11 @@ The merchant can now verify against the public key ``age_commitment[k]`` of the corresponding age group, say, ``k``. (The minimum age must fall into the age group at index ``k`` as defined by the exchange). - + **Note**: This applies only to coins for denominations that have support for age restriction. Denominations *without* support for age restriction *always* satisfy any minimum age requirement. - + Changes in the Wallet @@ -676,4 +676,3 @@ The scheme is as follows: (R, s) := signature return [s] * G == R + [SHA-512(R ∥ P ∥ message)] * P } - diff --git a/design-documents/025-withdraw-from-wallet.rst b/design-documents/025-withdraw-from-wallet.rst index c743c75b..a00d7a1b 100644 --- a/design-documents/025-withdraw-from-wallet.rst +++ b/design-documents/025-withdraw-from-wallet.rst @@ -1,5 +1,5 @@ -DD 025: Withdraw coins manually starting from the wallet -######################################################### +DD25: Withdraw coins manually starting from the wallet +###################################################### Summary ======= @@ -60,10 +60,7 @@ Alternatives * should we show the terms of service? -* exchange field first has been discussed, but the exchange list its only showing the - current currency exchanges, the user need to switch the currency first. Adding a +* exchange field first has been discussed, but the exchange list its only showing the + current currency exchanges, the user need to switch the currency first. Adding a new exchange should be done in a different context that can be accessed using the ``add exchange`` link - - - diff --git a/design-documents/026-refund-fees.rst b/design-documents/026-refund-fees.rst index b460b439..b6a31fe0 100644 --- a/design-documents/026-refund-fees.rst +++ b/design-documents/026-refund-fees.rst @@ -1,5 +1,5 @@ -Refunds and Fees -################ +DD26: Refunds and Fees +###################### Summary ======= diff --git a/design-documents/027-sandboxing-taler.rst b/design-documents/027-sandboxing-taler.rst index 0edf8e72..c671e55d 100644 --- a/design-documents/027-sandboxing-taler.rst +++ b/design-documents/027-sandboxing-taler.rst @@ -1,5 +1,5 @@ -Design Doc 027: Sandboxing all the Taler services. -################################################## +DD27: Sandboxing all the Taler services +####################################### .. note:: diff --git a/design-documents/028-proof-of-escrow.rst b/design-documents/028-proof-of-escrow.rst index 103b3a92..402ddd2c 100644 --- a/design-documents/028-proof-of-escrow.rst +++ b/design-documents/028-proof-of-escrow.rst @@ -1,5 +1,5 @@ -DD 028: Proof of escrow in the exchange -####################################### +DD28: Proof of escrow in the exchange +##################################### .. note:: diff --git a/design-documents/029-mobile-ui.rst b/design-documents/029-mobile-ui.rst index f4dbdb17..ddb5b0ca 100644 --- a/design-documents/029-mobile-ui.rst +++ b/design-documents/029-mobile-ui.rst @@ -1,10 +1,10 @@ -Template -######## +DD29: Mobile P2P UI +################### Summary ======= -Design the ui and interaction of p2p payments using mobile +Design the ui and interaction of p2p payments using mobile Motivation ========== @@ -19,7 +19,7 @@ Requirements * It should be able to request payment before any withdraw (currency still unknown) * It should support multi-device * The user may opt-in to be findable through a registry service - + Proposed Solution ================= diff --git a/design-documents/030-offline-payments.rst b/design-documents/030-offline-payments.rst index 5466d7c2..f2b3027e 100644 --- a/design-documents/030-offline-payments.rst +++ b/design-documents/030-offline-payments.rst @@ -1,5 +1,5 @@ -Design Doc 030: Offline payments -####################################### +DD30: Offline payments +###################### Summary ======= diff --git a/design-documents/031-invoicing.rst b/design-documents/031-invoicing.rst index be1ec670..4e2ebc5f 100644 --- a/design-documents/031-invoicing.rst +++ b/design-documents/031-invoicing.rst @@ -1,5 +1,5 @@ -Invoicing -######### +DD31: Invoicing +############### Summary ======= diff --git a/design-documents/032-auctions.rst b/design-documents/032-auctions.rst index 737cb07a..0f144988 100644 --- a/design-documents/032-auctions.rst +++ b/design-documents/032-auctions.rst @@ -1,5 +1,5 @@ -Auctions -######## +DD32: Auctions +############## Summary ======= -- cgit v1.2.3