@mento-protocol/mento-sdk 3.2.0-beta.0 → 3.2.0

package/README.md

@@ -155,6 +155,16 @@ const openTx = await mento.borrow.buildOpenTroveTransaction('USDm', {
 // Get trove data
 const trove = await mento.borrow.getTroveData('USDm', troveId)
 
+// Get troves currently owned by an address via the Trove NFT
+const troves = await mento.borrow.getUserTroves('USDm', ownerAddress)
+
+// Zombie troves are still-open troves whose debt fell below the branch minimum debt,
+// typically after redemption. They can still hold collateral, and may even have 0 debt.
+if (trove.status === 'zombie') {
+  // Reactivate by adjusting the zombie trove, or close it to withdraw remaining collateral.
+  const closeTx = await mento.borrow.buildCloseTroveTransaction('USDm', trove.troveId)
+}
+
 // Get system parameters
 const params = await mento.borrow.getSystemParams('USDm')
 
@@ -166,6 +176,12 @@ const fee = await mento.borrow.predictOpenTroveUpfrontFee(
 )
 ```
 
+Notes:
+
+- `getUserTroves()` reflects current Trove NFT ownership. It includes zombie troves still owned by the address, even though zombie troves are removed from `SortedTroves`.
+- `status === 'zombie'` does not mean liquidated. Zombie troves can still exist with collateral remaining on-chain, including the case where `debt === 0`.
+- Use `buildClaimCollateralTransaction()` for collateral surplus after liquidation. For zombie troves with remaining collateral, use `buildCloseTroveTransaction()` to withdraw it, or `buildAdjustZombieTroveTransaction()` to reactivate the trove.
+
 ## Supported Chains
 
 | Chain | Chain ID | Constant |

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mento-protocol/mento-sdk",
   "description": "Official SDK for interacting with the Mento Protocol",
-  "version": "3.2.0-beta.0",
+  "version": "3.2.0",
   "license": "MIT",
   "author": "Mento Labs",
   "keywords": [