Interface MusdClient

Readonlyaddresses

ReadonlychainId

Readonlycontracts

Readonlyfixed

addCollateral

• addCollateral(params: { amount: bigint }): Promise<WriteResult>

• addColl(hints) payable, top up collateral.

  Parameters

  • params: { amount: bigint }

  Returns Promise<WriteResult>

adjustTrove

• adjustTrove(params: AdjustTroveParams): Promise<WriteResult>

• adjustTrove(...), combined collateral ± and/or debt ± (validated).

  Parameters

  • params: AdjustTroveParams

  Returns Promise<WriteResult>

balanceOf

• balanceOf(address: `0x${string}`): Promise<bigint>

• MUSD ERC-20 balance.

  Parameters

  • address: `0x${string}`

  Returns Promise<bigint>

batchLiquidate

• batchLiquidate(borrowers: readonly `0x${string}`[]): Promise<WriteResult>

• Liquidate several Troves in one call.

  Parameters

  • borrowers: readonly `0x${string}`[]

  Returns Promise<WriteResult>

borrow

• borrow(params: BorrowParams): Promise<WriteResult>

• withdrawMUSD(amount, hints), borrow more (mint).

  Parameters

  • params: BorrowParams

  Returns Promise<WriteResult>

claim

• claim(): Promise<ClaimResult>

• claimCollateral(), claim surplus; a safe no-op when there is none.

  Returns Promise<ClaimResult>

close

• close(): Promise<WriteResult>

• closeTrove(), full payoff (needs entireDebt − 200 MUSD; returns 200 + collateral).

  Returns Promise<WriteResult>

computeEntireDebt

• computeEntireDebt(params: ComputeEntireDebtParams): bigint

• Project entire debt with simple time-based interest. Pure.

  Parameters

  • params: ComputeEntireDebtParams

  Returns bigint

computeHints

• computeHints(params: ComputeHintsParams): Promise<Hints>

• The insertion-hint ritual → { upperHint, lowerHint, nicr } for a position of the given shape.

  Parameters

  • params: ComputeHintsParams

  Returns Promise<Hints>

computeICR

• computeICR(params: ComputeICRParams): bigint

• (collateral × price) / entireDebt (== contract computeCR). Pure.

  Parameters

  • params: ComputeICRParams

  Returns bigint

computeLiquidationPrice

• computeLiquidationPrice(params: ComputeLiquidationPriceParams): bigint

• Price at which a position hits MCR = (MCR × entireDebt) / collateral. Pure.

  Parameters

  • params: ComputeLiquidationPriceParams

  Returns bigint

computeNICR

• computeNICR(params: ComputeNICRParams): bigint

• Nominal collateral ratio (collateral × 1e20) / entireDebt (pure, no network).

  Parameters

  • params: ComputeNICRParams

  Returns bigint

getBorrowingFee

• getBorrowingFee(debt: bigint): Promise<bigint>

• Passthrough to borrowerOperations.getBorrowingFee(debt) (parameterized, not cached).

  Parameters

  • debt: bigint

  Returns Promise<bigint>

getBorrowingPower

• getBorrowingPower(params: GetBorrowingPowerParams): Promise<bigint>

• Largest valid draw (ICR ≥ binding ratio, netDebt ≥ minNetDebt).

  Parameters

  • params: GetBorrowingPowerParams

  Returns Promise<bigint>

getClaimableCollateral

• getClaimableCollateral(address: `0x${string}`): Promise<bigint>

• BTC surplus claimable by address (CollSurplusPool), pair with claim().

  Parameters

  • address: `0x${string}`

  Returns Promise<bigint>

getConstants

• getConstants(): Promise<MusdConstants>

• Read + cache the governable constants on first use, returned together with the fixed ones. Also runs verifyDeployment once.

  Returns Promise<MusdConstants>

getHealthFactor

• getHealthFactor(params: { icr: bigint }): number

• icr / MCR as a number (1.0 at MCR). Pure.

  Parameters

  • params: { icr: bigint }

  Returns number

getOraclePrice

• getOraclePrice(): Promise<bigint>

• BTC/USD from PriceFeed.fetchPrice().

  Returns Promise<bigint>

getSystemState

• getSystemState(): Promise<SystemState>

• Protocol-wide live state ({ tcr, isRecoveryMode, price }).

  Returns Promise<SystemState>

getTrove

• getTrove(address: `0x${string}`): Promise<Trove>

• A fully-typed live position, correct by construction.

  Parameters

  • address: `0x${string}`

  Returns Promise<Trove>

isLiquidatable

• isLiquidatable(address: `0x${string}`): Promise<boolean>

• Normal-mode liquidatability (getCurrentICR < MCR).

  Parameters

  • address: `0x${string}`

  Returns Promise<boolean>

liquidate

• liquidate(borrower: `0x${string}`): Promise<WriteResult>

• Liquidate one Trove; throws NothingToLiquidate if it isn't liquidatable.

  Parameters

  • borrower: `0x${string}`

  Returns Promise<WriteResult>

openTrove

• openTrove(params: OpenTroveParams): Promise<WriteResult>

• openTrove(debt, hints) payable, opens a Trove with hints absorbed.

  Parameters

  • params: OpenTroveParams

  Returns Promise<WriteResult>

previewOpen

• previewOpen(params: PreviewOpenParams): Promise<OpenPreview>

• Preview opening a Trove: fee, debt, ICR, liquidation price, and the floor/RM flags.

  Parameters

  • params: PreviewOpenParams

  Returns Promise<OpenPreview>

redeem

• redeem(params: RedeemParams): Promise<RedeemResult>

• Redeem MUSD for BTC (hints + governable fee + truncation surfaced).

  Parameters

  • params: RedeemParams

  Returns Promise<RedeemResult>

refinance

• refinance(): Promise<WriteResult>

• refinance(hints), move to the current global rate (adds a refinancing fee).

  Returns Promise<WriteResult>

repay

• repay(params: { amount: bigint }): Promise<WriteResult>

• repayMUSD(amount, hints), reduce debt (no approval needed).

  Parameters

  • params: { amount: bigint }

  Returns Promise<WriteResult>

verifyDeployment

• verifyDeployment(): Promise<void>

• Defense-in-depth: read MCR/CCR from the chain and assert they equal the bundled fixed constants. Cached after the first success.

  Returns Promise<void>

  Throws

withdrawCollateral

• withdrawCollateral(params: { amount: bigint }): Promise<WriteResult>

• withdrawColl(amount, hints), take collateral out.

  Parameters

  • params: { amount: bigint }

  Returns Promise<WriteResult>