fix(borrow): correct JSDoc examples to use GBPm instead of USDm (MEN-41) (#138)

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>

Author: mento-val

src/services/borrow/BorrowService.ts

@@ -19,15 +19,15 @@ import { DeploymentContext } from './internal/borrowTypes'
  * handle interest rates and batch managers, and query position data.
  *
  * All `build*` methods return `CallParams` ({ to, data, value }) that can be
- * executed with any wallet client. The `debtTokenSymbol` parameter (e.g., 'USDm')
+ * executed with any wallet client. The `debtTokenSymbol` parameter (e.g., 'GBPm')
  * identifies which borrowing deployment to interact with.
  *
  * @example
  * ```typescript
  * const mento = await Mento.create(ChainId.CELO)
  *
  * // Open a trove
- * const tx = await mento.borrow.buildOpenTroveTransaction('USDm', {
+ * const tx = await mento.borrow.buildOpenTroveTransaction('GBPm', {
  *   owner: '0x...', ownerIndex: 0,
  *   collAmount: parseUnits('10', 18),
  *   boldAmount: parseUnits('1000', 18),
@@ -57,7 +57,7 @@ export class BorrowService {
    * Builds a transaction to open a new trove (borrowing position).
    * Requires prior collateral approval via `buildCollateralApprovalParams`.
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @param params - Trove opening parameters including collateral, debt amount, and interest rate
    * @returns Transaction parameters ready to send
    */
@@ -68,7 +68,7 @@ export class BorrowService {
   /**
    * Builds a transaction to adjust an existing trove's collateral and/or debt.
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @param params - Adjustment parameters specifying collateral/debt changes
    * @returns Transaction parameters ready to send
    */
@@ -80,7 +80,7 @@ export class BorrowService {
    * Builds a transaction to adjust a zombie trove (a trove that fell below minimum debt
    * after a liquidation). Same parameters as `buildAdjustTroveTransaction`.
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @param params - Adjustment parameters specifying collateral/debt changes
    * @returns Transaction parameters ready to send
    */
@@ -96,7 +96,7 @@ export class BorrowService {
   /**
    * Builds a transaction to close a trove, repaying all debt and reclaiming collateral.
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @param troveId - The NFT token ID identifying the trove
    * @returns Transaction parameters ready to send
    */
@@ -108,7 +108,7 @@ export class BorrowService {
    * Builds a transaction to add collateral to an existing trove.
    * Requires prior collateral approval via `buildCollateralApprovalParams`.
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @param troveId - The NFT token ID identifying the trove
    * @param amount - Amount of collateral to add (in wei)
    * @returns Transaction parameters ready to send
@@ -126,7 +126,7 @@ export class BorrowService {
   /**
    * Builds a transaction to withdraw collateral from an existing trove.
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @param troveId - The NFT token ID identifying the trove
    * @param amount - Amount of collateral to withdraw (in wei)
    * @returns Transaction parameters ready to send
@@ -144,7 +144,7 @@ export class BorrowService {
   /**
    * Builds a transaction to borrow additional debt against an existing trove.
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @param troveId - The NFT token ID identifying the trove
    * @param amount - Additional debt amount to borrow (in wei)
    * @param maxFee - Maximum upfront fee the borrower is willing to pay (in wei)
@@ -164,7 +164,7 @@ export class BorrowService {
   /**
    * Builds a transaction to repay debt on an existing trove.
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @param troveId - The NFT token ID identifying the trove
    * @param amount - Amount of debt to repay (in wei)
    * @returns Transaction parameters ready to send
@@ -182,7 +182,7 @@ export class BorrowService {
   /**
    * Builds a transaction to change the annual interest rate on a trove.
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @param troveId - The NFT token ID identifying the trove
    * @param newRate - New annual interest rate (18-decimal fixed-point, e.g., parseUnits('0.05', 18) for 5%)
    * @param maxFee - Maximum upfront fee the borrower is willing to pay (in wei)
@@ -202,7 +202,7 @@ export class BorrowService {
   /**
    * Builds a transaction to claim collateral surplus after a liquidation.
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @returns Transaction parameters ready to send
    */
   buildClaimCollateralTransaction(debtTokenSymbol: string): Promise<CallParams> {
@@ -212,7 +212,7 @@ export class BorrowService {
   /**
    * Builds a transaction to delegate interest rate management to a batch manager.
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @param troveId - The NFT token ID identifying the trove
    * @param manager - Address of the batch manager contract
    * @param maxFee - Maximum upfront fee the borrower is willing to pay (in wei)
@@ -232,7 +232,7 @@ export class BorrowService {
   /**
    * Builds a transaction to remove a trove from a batch manager, setting a new individual rate.
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @param troveId - The NFT token ID identifying the trove
    * @param newRate - New individual annual interest rate (18-decimal fixed-point)
    * @param maxFee - Maximum upfront fee the borrower is willing to pay (in wei)
@@ -252,7 +252,7 @@ export class BorrowService {
   /**
    * Builds a transaction to switch a trove to a different batch manager.
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @param troveId - The NFT token ID identifying the trove
    * @param newManager - Address of the new batch manager contract
    * @param maxFee - Maximum upfront fee the borrower is willing to pay (in wei)
@@ -273,7 +273,7 @@ export class BorrowService {
    * Builds a transaction to delegate interest rate management to another address
    * with bounded rate constraints.
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @param troveId - The NFT token ID identifying the trove
    * @param delegate - Address to delegate interest rate management to
    * @param minRate - Minimum allowed annual interest rate (18-decimal fixed-point)
@@ -310,7 +310,7 @@ export class BorrowService {
   /**
    * Builds a transaction to remove the interest rate delegate from a trove.
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @param troveId - The NFT token ID identifying the trove
    * @returns Transaction parameters ready to send
    */
@@ -327,7 +327,7 @@ export class BorrowService {
    * Builds approval params to allow BorrowerOperations to spend collateral tokens.
    * Must be executed before `buildOpenTroveTransaction` or `buildAddCollTransaction`.
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @param amount - Amount of collateral to approve (in wei)
    * @returns Transaction parameters for the ERC-20 approve call
    */
@@ -340,7 +340,7 @@ export class BorrowService {
   /**
    * Builds approval params for the debt token (e.g., for repayment or closing).
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @param spender - Address to approve as spender
    * @param amount - Amount of debt tokens to approve (in wei)
    * @returns Transaction parameters for the ERC-20 approve call
@@ -358,7 +358,7 @@ export class BorrowService {
   /**
    * Builds approval params for the gas compensation token (required when opening a trove).
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @param amount - Amount to approve (in wei). If omitted, approves the gas compensation amount.
    * @returns Transaction parameters for the ERC-20 approve call
    */
@@ -374,7 +374,7 @@ export class BorrowService {
   /**
    * Gets the current collateral token allowance for BorrowerOperations.
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @param owner - Address to check allowance for
    * @returns Current allowance in wei
    */
@@ -385,7 +385,7 @@ export class BorrowService {
   /**
    * Gets the current debt token allowance for a specific spender.
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @param owner - Address to check allowance for
    * @param spender - Address of the approved spender
    * @returns Current allowance in wei
@@ -399,7 +399,7 @@ export class BorrowService {
   /**
    * Gets the current gas compensation token allowance.
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @param owner - Address to check allowance for
    * @returns Current allowance in wei
    */
@@ -410,7 +410,7 @@ export class BorrowService {
   /**
    * Fetches on-chain data for a specific trove.
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @param troveId - The NFT token ID identifying the trove
    * @returns Trove position data including collateral, debt, interest rate, and status
    */
@@ -421,7 +421,7 @@ export class BorrowService {
   /**
    * Fetches all troves owned by an address.
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @param owner - Address to query troves for
    * @returns Array of trove positions owned by the address
    */
@@ -432,7 +432,7 @@ export class BorrowService {
   /**
    * Gets the current collateral token price from the price feed.
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @returns Collateral price in 18-decimal fixed-point format
    */
   getCollateralPrice(debtTokenSymbol: string): Promise<bigint> {
@@ -443,7 +443,7 @@ export class BorrowService {
    * Gets the system parameters for a borrowing deployment.
    * Returns MCR, CCR, SCR, BCR, minimum debt, gas compensation, and minimum interest rate.
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @returns System parameters (all values in 18-decimal fixed-point)
    */
   getSystemParams(debtTokenSymbol: string): Promise<SystemParams> {
@@ -453,7 +453,7 @@ export class BorrowService {
   /**
    * Checks whether the borrowing system has been shut down (e.g., during a crisis).
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @returns true if the system is shut down, false otherwise
    */
   isSystemShutDown(debtTokenSymbol: string): Promise<boolean> {
@@ -463,7 +463,7 @@ export class BorrowService {
   /**
    * Gets aggregate collateral and debt statistics for the borrowing branch.
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @returns Total collateral and total debt across all troves (in wei)
    */
   getBranchStats(debtTokenSymbol: string): Promise<{ totalColl: bigint; totalDebt: bigint }> {
@@ -473,7 +473,7 @@ export class BorrowService {
   /**
    * Gets the distribution of debt across interest rate brackets.
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @returns Array of brackets, each with a rate and total debt at that rate
    */
   getInterestRateBrackets(debtTokenSymbol: string): Promise<InterestRateBracket[]> {
@@ -483,7 +483,7 @@ export class BorrowService {
   /**
    * Gets the weighted average interest rate across all active troves.
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @returns Average annual interest rate in 18-decimal fixed-point
    */
   getAverageInterestRate(debtTokenSymbol: string): Promise<bigint> {
@@ -493,7 +493,7 @@ export class BorrowService {
   /**
    * Gets information about a batch manager's configuration.
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @param address - Address of the batch manager
    * @returns Batch manager config (min/max rate, min change period), or null if not a valid manager
    */
@@ -507,7 +507,7 @@ export class BorrowService {
   /**
    * Estimates the upfront fee for opening a new trove.
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @param amount - Debt amount to borrow (in wei)
    * @param rate - Annual interest rate (18-decimal fixed-point)
    * @returns Estimated upfront fee in wei
@@ -525,7 +525,7 @@ export class BorrowService {
   /**
    * Estimates the upfront fee for increasing debt on an existing trove.
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @param troveId - The NFT token ID identifying the trove
    * @param debtIncrease - Amount of additional debt (in wei)
    * @returns Estimated upfront fee in wei
@@ -543,7 +543,7 @@ export class BorrowService {
   /**
    * Estimates the upfront fee for changing a trove's interest rate.
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @param troveId - The NFT token ID identifying the trove
    * @param newRate - New annual interest rate (18-decimal fixed-point)
    * @returns Estimated upfront fee in wei
@@ -561,7 +561,7 @@ export class BorrowService {
   /**
    * Estimates the upfront fee for joining a batch manager.
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @param troveId - The NFT token ID identifying the trove
    * @param batchAddress - Address of the batch manager to join
    * @returns Estimated upfront fee in wei
@@ -580,7 +580,7 @@ export class BorrowService {
    * Gets the next available owner index for opening a new trove.
    * Each owner can have multiple troves, indexed starting from 0.
    *
-   * @param debtTokenSymbol - The debt token symbol (e.g., 'USDm')
+   * @param debtTokenSymbol - The debt token symbol (e.g., 'GBPm')
    * @param owner - Address of the trove owner
    * @returns The next available index (pass to OpenTroveParams.ownerIndex)
    */