From 1bac5329b510e74d644d0edbf6118b527b10c8ad Mon Sep 17 00:00:00 2001
From: Florian Dold <florian.dold@gmail.com>
Date: Tue, 24 Mar 2020 17:57:44 +0530
Subject: docs

---
 src/types/talerTypes.ts | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

(limited to 'src/types/talerTypes.ts')

diff --git a/src/types/talerTypes.ts b/src/types/talerTypes.ts
index 90751940d..0f35f7ede 100644
--- a/src/types/talerTypes.ts
+++ b/src/types/talerTypes.ts
@@ -731,16 +731,51 @@ export class WithdrawResponse {
   ev_sig: string;
 }
 
+/**
+ * Easy to process format for the public data of coins
+ * managed by the wallet.
+ */
 export interface CoinDumpJson {
   coins: Array<{
+    /**
+     * The coin's denomination's public key.
+     */
     denom_pub: string;
+    /**
+     * Hash of denom_pub.
+     */
     denom_pub_hash: string;
+    /**
+     * Value of the denomination (without any fees).
+     */
     denom_value: string;
+    /**
+     * Public key of the coin.
+     */
     coin_pub: string;
+    /**
+     * Base URL of the exchange for the coin.
+     */
     exchange_base_url: string;
+    /**
+     * Remaining value on the coin, to the knowledge of
+     * the wallet.
+     */
     remaining_value: string;
+    /**
+     * Public key of the parent coin.
+     * Only present if this coin was obtained via refreshing.
+     */
     refresh_parent_coin_pub: string | undefined;
+    /**
+     * Public key of the reserve for this coin.
+     * Only present if this coin was obtained via refreshing.
+     */
     withdrawal_reserve_pub: string | undefined;
+    /**
+     * Is the coin suspended?
+     * Suspended coins are not considered for payments.
+     */
     coin_suspended: boolean;
   }>;
 }
-- 
cgit v1.2.3