taler-typescript-core

commit d1b04a2b731e67da43cf5aa8dbc13c9fafb8d2c6
parent ccfef3a5f43cb3f9f7124fd0c51321aa0c4bfd20
Author: Florian Dold <florian@dold.me>
Date:   Tue, 21 Oct 2025 16:43:22 +0200

-doc comments

Diffstat:
M
packages/taler-util/src/types-taler-wallet.ts
 | 
22
++++++++++++++++++++--

1 file changed, 20 insertions(+), 2 deletions(-)
diff --git a/packages/taler-util/src/types-taler-wallet.ts b/packages/taler-util/src/types-taler-wallet.ts
@@ -65,7 +65,16 @@ import {
 } from "./time.js";
 import { BlindedDonationReceiptKeyPair } from "./types-donau.js";
 import { WithdrawalOperationStatusFlag } from "./types-taler-bank-integration.js";
-import { AmountString, codecForEddsaPrivateKey, CurrencySpecification, EddsaPrivateKeyString, EddsaPublicKeyString, EddsaSignatureString, HashCode, Timestamp } from "./types-taler-common.js";
+import {
+  AmountString,
+  CurrencySpecification,
+  EddsaPrivateKeyString,
+  EddsaPublicKeyString,
+  EddsaSignatureString,
+  HashCode,
+  Timestamp,
+  codecForEddsaPrivateKey,
+} from "./types-taler-common.js";
 import {
   AccountRestriction,
   AuditorDenomSig,
@@ -543,10 +552,14 @@ export interface DonauSummaryItem {
   /** Year of the donation(s). */
   year: number;
   /**
-   * Sum of donation receipts in the
+   * Sum of donation receipts we received from merchants in the
    * applicable year.
    */
   amountReceiptsAvailable: AmountString;
+  /**
+   * Sum of donation receipts that were already submitted
+   * to the donau in the applicable year.
+   */
   amountReceiptsSubmitted: AmountString;
   /**
    * Amount of the latest available statement. Missing if no statement
@@ -555,8 +568,13 @@ export interface DonauSummaryItem {
   amountStatement?: AmountString;
 }
 
+/**
+ * Response to a getBalances request.
+ */
 export interface BalancesResponse {
+  /** Electronic cash balances, per currency scope. */
   balances: WalletBalance[];
+  /* Summary of donations, per donau/year/currency. */
   donauSummary?: DonauSummaryItem[];
 }