diff options
author | Christian Grothoff <christian@grothoff.org> | 2022-07-06 22:49:27 +0200 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2022-07-06 22:49:27 +0200 |
commit | 1c2a5409a96855440710b66c08b40945e37892c3 (patch) | |
tree | 4d69f34b9e4af84eaa384fd09a5d5f596140d723 /core | |
parent | f74f02c64d7ec515d37299b405ed06d166e28114 (diff) | |
download | docs-1c2a5409a96855440710b66c08b40945e37892c3.tar.gz docs-1c2a5409a96855440710b66c08b40945e37892c3.tar.bz2 docs-1c2a5409a96855440710b66c08b40945e37892c3.zip |
fix misc typos
Diffstat (limited to 'core')
-rw-r--r-- | core/api-bank-access.rst | 20 | ||||
-rw-r--r-- | core/api-common.rst | 22 | ||||
-rw-r--r-- | core/api-exchange.rst | 21 | ||||
-rw-r--r-- | core/api-mailbox.rst | 28 | ||||
-rw-r--r-- | core/api-taldir.rst | 10 |
5 files changed, 65 insertions, 36 deletions
diff --git a/core/api-bank-access.rst b/core/api-bank-access.rst index 0d1450a8..a33cbdbb 100644 --- a/core/api-bank-access.rst +++ b/core/api-bank-access.rst @@ -45,12 +45,14 @@ Accounts and Withdrawals publicAccounts: PublicAccount[] } + .. ts:def:: PublicAccount + interface PublicAccount { iban: string; balance: string; // The account name _and_ the username of the // Sandbox customer that owns such a bank account. - accountLabel: string; + accountLabel: string; } The following endpoints require HTTP "Basic" authentication with the account @@ -173,16 +175,16 @@ Transactions query parameters, it returns the last 5 transactions. **Request** - + :query page: page number (defaults to 1, meaning the page with the latest transactions.) :query size: how many transactions per page, defaults to 5. **Response** - + .. ts:def:: BankAccountTransactionsResponse interface BankAccountTransactionsResponse { - transactions: BankAccountTransactionInfo[]; + transactions: BankAccountTransactionInfo[]; } .. http:GET:: ${BANK_API_BASE_URL}/accounts/${account_name}/transactions/${transaction_id} @@ -193,13 +195,13 @@ Transactions in the following format: .. ts:def:: BankAccountTransactionInfo - + interface BankAccountTransactionInfo { - + creditorIban: string; creditorBic: string; // Optional creditorName: string; - + debtorIban: string; debtorBic: string; debtorName: string; @@ -207,7 +209,7 @@ Transactions amount: number; currency: string; subject: string; - + // Transaction unique ID. Matches // $transaction_id from the URI. uid: string; @@ -223,7 +225,7 @@ Transactions **Request** .. ts:def:: BankAccountTransactionCreate - + interface CreateBankAccountTransactionCreate { // Address in the Payto format of the wire transfer receiver. diff --git a/core/api-common.rst b/core/api-common.rst index 2ceca5ea..d170c1d4 100644 --- a/core/api-common.rst +++ b/core/api-common.rst @@ -291,7 +291,7 @@ Timestamps are represented by the following structure: .. ts:def:: RelativeTime - interface Duration { + interface RelativeTime { // Duration in microseconds or "forever" // to represent an infinite duration. Numeric // values are capped at 2^53 - 1 inclusive. @@ -968,6 +968,26 @@ within the struct TALER_AmountNBO closing_fee; }; +.. _TALER_GlobalFeesPS: +.. sourcecode:: c + + struct TALER_MasterWireFeePS { + /** + * purpose.purpose = TALER_SIGNATURE_MASTER_GLOBAL_FEES + */ + struct GNUNET_CRYPTO_EccSignaturePurpose purpose; + struct GNUNET_TIME_AbsoluteNBO start_date; + struct GNUNET_TIME_AbsoluteNBO end_date; + struct GNUNET_TIME_RelativeNBO purse_timeout; + struct GNUNET_TIME_RelativeNBO kyc_timeout; + struct GNUNET_TIME_RelativeNBO history_expiration; + struct TALER_AmountNBO history_fee; + struct TALER_AmountNBO kyc_fee; + struct TALER_AmountNBO account_fee; + struct TALER_AmountNBO purse_fee; + uint32_t purse_account_limit; + }; + .. _TALER_DepositTrackPS: .. sourcecode:: c diff --git a/core/api-exchange.rst b/core/api-exchange.rst index 937298a3..65c35575 100644 --- a/core/api-exchange.rst +++ b/core/api-exchange.rst @@ -259,7 +259,7 @@ possibly by using HTTPS. // // A value of 0 means that the exchange does not support the extension for // age-restriction. - type AgeMask = integer; + type AgeMask = Integer; .. ts:def:: DenomGroup @@ -1357,7 +1357,7 @@ exchange. // True if the purse was actually merged. // If false, only the purse_fee has an impact // on the reserve balance! - merged: Boolean; + merged: boolean; } .. ts:def:: ReserveHistoryTransaction @@ -1618,7 +1618,7 @@ exchange. // Hash of the public key of the denomination the // request relates to. - denom_pub_hash: Hash; + denom_pub_hash: HashCode; } @@ -2474,7 +2474,7 @@ denomination. The fields of the response are the same in both cases. The request should not be repeated again with this coin. In this case, the response is a `DepositDoubleSpendError` with - an additional `coin_pub` field specifying the public key of the + an additional ``coin_pub`` field specifying the public key of the coin that was double-spent. :http:statuscode:`410 Gone`: The requested denomination key is not yet or no longer valid. @@ -2652,7 +2652,7 @@ the API during normal operation. // Hash of the public key of the denomination the // request relates to. Must be a CS denomination type. - denom_pub_hash: Hash; + denom_pub_hash: HashCode; } @@ -3097,7 +3097,7 @@ in using this API. // operation (see /csr-melt). ewv: ExchangeWithdrawValue; - // Signature of `TALER_RecoupRefreshRequestPS` created with + // Signature of `TALER_RecoupRequestPS` created with // the `coin's private key <coin-priv>`. coin_sig: EddsaSignature; @@ -3630,7 +3630,8 @@ Wallet-to-wallet transfers .. ts:def:: PurseCreateConflict interface PurseCreateConflict { - code: TALER_EC_EXCHANGE_PURSE_CREATE_CONFLICTING_META_DATA; + // Must be equal to TALER_EC_EXCHANGE_PURSE_CREATE_CONFLICTING_META_DATA + code: Integer; // Total amount to be merged into the reserve. // (excludes fees). @@ -3662,7 +3663,8 @@ Wallet-to-wallet transfers .. ts:def:: PurseDepositConflict interface PurseDepositConflict { - code: TALER_EC_EXCHANGE_PURSE_DEPOSIT_CONFLICTING_META_DATA; + // Must be equal to TALER_EC_EXCHANGE_PURSE_DEPOSIT_CONFLICTING_META_DATA + code: Integer; // Public key of the coin being deposited into the purse. coin_pub: EddsaPublicKey; @@ -3685,7 +3687,8 @@ Wallet-to-wallet transfers .. ts:def:: PurseContractConflict interface PurseContractConflict { - code: TALER_EC_EXCHANGE_PURSE_ECONTRACT_CONFLICTING_META_DATA; + // Must be equal to TALER_EC_EXCHANGE_PURSE_ECONTRACT_CONFLICTING_META_DATA + code: Integer; // Hash of the encrypted contract. h_econtract: HashCode; diff --git a/core/api-mailbox.rst b/core/api-mailbox.rst index 25c9cd87..4633777e 100644 --- a/core/api-mailbox.rst +++ b/core/api-mailbox.rst @@ -107,7 +107,7 @@ Configuration information // How long will the service store a message // before giving up on delivery? - delivery_period: Duration; + delivery_period: RelativeTime; } @@ -145,17 +145,19 @@ Sending messages **Details:** .. _IdentityMessage: - .. ts:def:: IdentityMessage { - // Public DH key used to encrypt the body. Must be fresh - // and only used once (ephemeral). - ephemeral_key: EcdhePublicKey; + .. ts:def:: IdentityMessage - // Encrypted message. Must be exactly 256-32 bytes long. - body: string; + interface IdentityMessage { + // Public DH key used to encrypt the body. Must be fresh + // and only used once (ephemeral). + ephemeral_key: EcdhePublicKey; - // Order ID, if the client recently paid for this message. - order_id?: string; - } + // Encrypted message. Must be exactly 256-32 bytes long. + body: string; + + // Order ID, if the client recently paid for this message. + order_id?: string; + } .. _MailboxRateLimitedResponse: .. ts:def:: MailboxRateLimitedResponse @@ -223,14 +225,16 @@ Receiving messages **Details:** .. _MessageDeletionRequest: - .. ts:def:: MessageDeletionRequest { + .. ts:def:: MessageDeletionRequest + + interface MessageDeletionRequest { // Number of messages to delete. (Starting from the beginning // of the latest GET response). count: Integer; // SHA-512 hash over all messages to delete. - checksum: Hash; + checksum: HashCode; // Signature by the mailbox's private key affirming // the deletion of the messages, of purpuse diff --git a/core/api-taldir.rst b/core/api-taldir.rst index c527a40f..03212cc4 100644 --- a/core/api-taldir.rst +++ b/core/api-taldir.rst @@ -103,7 +103,7 @@ Configuration information name: "taler-directory"; // Supported registration methods - methods: Method; + methods: string; // fee for one month of registration monthly_fee: Amount; @@ -138,13 +138,13 @@ Address registration address: string; // Public key of the user to register - public_key: EdDSAPublicKey; + public_key: EddsaPublicKey; // (HTTPS) endpoint URL for the inbox service. inbox_url: string; // For how long should the registration last. - duration: Time; + duration: RelativeTime; // Order ID, if the client recently paid for this registration order_id?: string; @@ -230,7 +230,7 @@ Address registration // chosen by TalDir (encoded as string just as given in the URL, but // excluding the 0-termination) concatenated with the binary 32-byte // value representing the wallet's EdDSA public key. - solution: Hash; + solution: HashCode; } @@ -272,7 +272,7 @@ Address lookup interface MailboxDetailResponse { // Registered public key of the user - public_key: EdDSAPublicKey; + public_key: EddsaPublicKey; // (HTTPS) endpoint URL for the inbox service. inbox_url: string; |