Cleanup CongestionResponse documentation (iotaledger#2017)

* Cleanup CongestionResponse documentation * Update bindings/nodejs/lib/types/models/api/congestion-response.ts Co-authored-by: Thoralf-M <[email protected]> --------- Co-authored-by: Thoralf-M <[email protected]>
boxfish-studio · Feb 19, 2024 · 9a6ba79 · 9a6ba79
1 parent 257bcff
commit 9a6ba79
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 13 deletions.
diff --git a/bindings/nodejs/lib/types/models/api/congestion-response.ts b/bindings/nodejs/lib/types/models/api/congestion-response.ts
@@ -9,19 +9,19 @@ import { u64 } from '../../utils';
  */
 export class CongestionResponse {
     /**
-     * The slot index for which the congestion estimate is provided.
+     * Slot for which the estimate is provided.
      */
     slot!: SlotIndex;
     /**
-     * Indicates if a node is ready to issue a block in a current congestion or should wait.
+     * Indicates if a node is ready to schedule a block issued by the specified account, or if the issuer should wait.
      */
     ready!: boolean;
     /**
-     * The cost in mana for issuing a block in a current congestion estimated based on RMC and slot index.
+     * Mana cost a user needs to burn to issue a block in the slot.
      */
     referenceManaCost!: u64;
     /**
-     * The Block Issuance Credits of the requested account.
+     * BIC of the account in the slot. This balance needs to be non-negative, otherwise account is locked.
      */
-    blockIssuanceCredits!: u64;
+    blockIssuanceCredits!: bigint;
 }
diff --git a/bindings/python/iota_sdk/client/responses.py b/bindings/python/iota_sdk/client/responses.py
@@ -164,10 +164,10 @@ class CongestionResponse:
     Response of GET /api/core/v3/accounts/{accountId}/congestion.
 
     Attributes:
-        slot: The slot index for which the congestion estimate is provided.
-        ready: Indicates if a node is ready to issue a block in a current congestion or should wait.
-        reference_mana_cost: The cost in mana for issuing a block in a current congestion estimated based on RMC and slot index.
-        block_issuance_credits: The Block Issuance Credits of the requested account.
+        slot: Slot for which the estimate is provided.
+        ready: Indicates if a node is ready to schedule a block issued by the specified account, or if the issuer should wait.
+        reference_mana_cost: Mana cost a user needs to burn to issue a block in the slot.
+        block_issuance_credits: BIC of the account in the slot. This balance needs to be non-negative, otherwise account is locked.
     """
     slot: SlotIndex
     ready: bool

diff --git a/sdk/src/types/api/core.rs b/sdk/src/types/api/core.rs
@@ -334,14 +334,14 @@ impl IssuanceBlockHeaderResponse {
 #[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
 #[serde(rename_all = "camelCase")]
 pub struct CongestionResponse {
-    /// The slot index for which the congestion estimate is provided.
+    /// Slot for which the estimate is provided.
     pub slot: SlotIndex,
-    /// Indicates if a node is ready to issue a block in a current congestion or should wait.
+    /// Indicates if a node is ready to schedule a block issued by the specified account, or if the issuer should wait.
     pub ready: bool,
-    /// The cost in mana for issuing a block in a current congestion estimated based on RMC and slot index.
+    /// Mana cost a user needs to burn to issue a block in the slot.
     #[serde(with = "string")]
     pub reference_mana_cost: u64,
-    /// The Block Issuance Credits of the requested account.
+    /// BIC of the account in the slot. This balance needs to be non-negative, otherwise account is locked.
     #[serde(with = "string")]
     pub block_issuance_credits: i128,
 }