From 214183b2daee70fed6e903eb97e032f9534d252a Mon Sep 17 00:00:00 2001
From: cuongquangnam <42933311+cuongquangnam@users.noreply.github.com>
Date: Fri, 11 Aug 2023 15:29:43 +0800
Subject: [PATCH] feat(whale-api-client): Add format for fields in BurnData
 (#2137)

<!--  Thanks for sending a pull request! -->

#### What this PR does / why we need it:

#### Which issue(s) does this PR fixes?:
<!--
(Optional) Automatically closes linked issue when PR is merged.
Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
-->
Fixes #2136

#### Additional comments?:

---------

Co-authored-by: Pierre Gee <pierre@cakedefi.com>
---
 packages/whale-api-client/src/api/stats.ts | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

diff --git a/packages/whale-api-client/src/api/stats.ts b/packages/whale-api-client/src/api/stats.ts
index 4b2e24bdc2..2656a1c01b 100644
--- a/packages/whale-api-client/src/api/stats.ts
+++ b/packages/whale-api-client/src/api/stats.ts
@@ -143,7 +143,7 @@ export interface SupplyData {
 export interface BurnData {
   address: string
   /**
-   * Amount send to burn address
+   * Amount of DFI send to burn address
    */
   amount: number
   /**
@@ -151,19 +151,19 @@ export interface BurnData {
    */
   tokens: string[]
   /**
-   * Amount collected via fee burn
+   * Amount of DFI collected via fee burn
    */
   feeburn: number
   /**
-   * Amount collected via emission burn
+   * Amount of DFI collected via emission burn
    */
   emissionburn: number
   /**
-   * Amount collected via auction burn
+   * Amount of DFI collected via auction burn
    */
   auctionburn: number
   /**
-   * Value of burn after payback
+   * Value of burn after payback (in DFI)
    */
   paybackburn: number
   /**
@@ -183,19 +183,19 @@ export interface BurnData {
    */
   dfipaybacktokens: string[]
   /**
-   * Amount of paybacks
+   * Amount of paybacks; formatted as AMOUNT@SYMBOL
    */
   paybackfees: string[]
   /**
-   * Amount of tokens that are paid back
+   * Amount of tokens that are paid back; formatted as AMOUNT@SYMBOL
    */
   paybacktokens: string[]
   /**
-   * Amount of tokens burned due to futureswap
+   * Amount of tokens burned due to futureswap; formatted as AMOUNT@SYMBOL
    */
   dfip2203: string[]
   /**
-   * Amount of tokens burned due to DFI-to-DUSD swap
+   * Amount of tokens burned due to DFI-to-DUSD swap; formatted as AMOUNT@SYMBOL
    */
   dfip2206f: string[]
 }