Preparing search index...
The search index is not available
musd-kit API reference
musd-kit API reference
core/src
Module core/src
Classes
BelowMinimumDebt
CollateralWithdrawalBlocked
ContractCallFailed
DeploymentVerificationFailed
ExceedsBorrowingCapacity
ICRBelowMCR
InsufficientCollateral
InsufficientMusdBalance
InvalidAddressOverride
InvalidAdjustment
InvalidAmount
LastTroveInSystem
MaxFeeExceeded
MismatchedDeployment
MissingWalletClient
MusdError
NothingToLiquidate
OracleStale
RecoveryModeRestriction
RedemptionBreachesDebtFloor
RedemptionFailed
RedemptionPriceFragile
RepayExceedsDebt
StaleHint
SystemRatioBelowCCR
TroveAlreadyExists
TroveNotFound
Unauthorized
UnsupportedChain
Interfaces
AccruedInterestParams
AdjustPreview
AdjustTroveParams
BorrowingCapacity
BorrowingPower
BorrowParams
BorrowPreview
ClaimResult
ClosePreview
ComputeEntireDebtParams
ComputeHintsParams
ComputeICRParams
ComputeLiquidationPriceParams
ComputeNICRParams
CreateMusdClientParams
DrawForMarginParams
DrawMargin
EligibleTrove
EvaluateAdjustInput
EvaluateBorrowInput
EvaluateCloseInput
EvaluateOpenInput
EvaluateRedeemInput
EvaluateRefinanceInput
GetBorrowingPowerParams
GovernableConstants
Hints
IsTroveLiquidatableParams
MarginDraw
MaxWithdrawable
MusdClient
MusdContracts
OpenPreview
OpenTroveParams
PartialRedemption
PreviewAdjustParams
PreviewBorrowParams
PreviewOpenParams
PreviewRedeemParams
RedeemParams
RedeemResult
RedemptionEstimateBeforeSend
RedemptionPreview
RefinancePreview
SettledRedemption
SystemState
Trove
TroveAmounts
WriteDiagnosis
WriteResult
Type Aliases
AdjustBlockReason
BorrowBlockReason
CloseBlockReason
EntireDebtAndColl
FixedConstants
GasDecision
MusdAddresses
MusdConstants
MusdContractName
MusdErrorCode
OpenBlockReason
RedeemBlockReason
RefinanceBlockReason
SupportedChainId
TroveStatus
WriteFailureKind
Variables
ALL_MUSD_ERROR_CODES
BPS_DIVISOR
CCR
DECIMAL_PRECISION
DEFAULT_CONSTANTS_TTL_MS
DEFAULT_GAS_MARGIN_PERCENT
DEFAULT_HINT_RANDOM_SEED
DEFAULT_REDEMPTION_MAX_ITERATIONS
FIXED_CONSTANTS
MCR
MIN_NET_DEBT_MIN
MULTICALL3_ADDRESS
MUSD_CONTRACT_NAMES
MUSD_GAS_COMPENSATION
MusdErrorCode
NICR_PRECISION
ONE_HUNDRED_PCT
PERCENT_DIVISOR
REDEMPTION_ADVICE_MARGIN_SECONDS
REDEMPTION_PRICE_MOVE_TOLERANCE
REDEMPTION_SEND_MARGIN_SECONDS
SECONDS_PER_YEAR
SUPPORTED_CHAIN_IDS
TroveStatus
Functions
accruedInterest
capacityAfterAdjustment
computeEntireDebt
computeHints
computeICR
computeLiquidationPrice
computeMaxWithdrawable
computeNICR
createContracts
createMusdClient
diagnoseRevertedWrite
drawForMargin
effectiveBorrowingFee
estimateCollateralDrawn
evaluateAdjust
evaluateBorrow
evaluateClose
evaluateOpen
evaluateRedeem
evaluateRefinance
exceedsRateCap
formatBtc
formatMusd
getAddresses
getBorrowingCapacity
getBorrowingPower
getHealthFactor
hasAddressOverride
isBorrowingFeeCharged
isSupportedChainId
isTroveLiquidatable
mapRevert
maxBorrowingCapacityAt
maxWithdrawableCollateral
netDebtOf
parseBps
parseBtc
parseMusd
partialRedemptionBand
previewAdjustTrove
previewBorrow
previewClose
previewOpen
previewRedeem
previewRefinance
previewWithdrawCollateral
revertReason
settledRedemptionFrom
trialsForSize
troveAmounts
withGasMargin
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Classes
Below
Minimum
Debt
Collateral
Withdrawal
Blocked
Contract
Call
Failed
Deployment
Verification
Failed
Exceeds
Borrowing
Capacity
ICRBelowMCR
Insufficient
Collateral
Insufficient
Musd
Balance
Invalid
Address
Override
Invalid
Adjustment
Invalid
Amount
Last
Trove
In
System
Max
Fee
Exceeded
Mismatched
Deployment
Missing
Wallet
Client
Musd
Error
Nothing
To
Liquidate
Oracle
Stale
Recovery
Mode
Restriction
Redemption
Breaches
Debt
Floor
Redemption
Failed
Redemption
Price
Fragile
Repay
Exceeds
Debt
Stale
Hint
System
Ratio
BelowCCR
Trove
Already
Exists
Trove
Not
Found
Unauthorized
Unsupported
Chain
Interfaces
Accrued
Interest
Params
Adjust
Preview
Adjust
Trove
Params
Borrowing
Capacity
Borrowing
Power
Borrow
Params
Borrow
Preview
Claim
Result
Close
Preview
Compute
Entire
Debt
Params
Compute
Hints
Params
ComputeICRParams
Compute
Liquidation
Price
Params
ComputeNICRParams
Create
Musd
Client
Params
Draw
For
Margin
Params
Draw
Margin
Eligible
Trove
Evaluate
Adjust
Input
Evaluate
Borrow
Input
Evaluate
Close
Input
Evaluate
Open
Input
Evaluate
Redeem
Input
Evaluate
Refinance
Input
Get
Borrowing
Power
Params
Governable
Constants
Hints
Is
Trove
Liquidatable
Params
Margin
Draw
Max
Withdrawable
Musd
Client
Musd
Contracts
Open
Preview
Open
Trove
Params
Partial
Redemption
Preview
Adjust
Params
Preview
Borrow
Params
Preview
Open
Params
Preview
Redeem
Params
Redeem
Params
Redeem
Result
Redemption
Estimate
Before
Send
Redemption
Preview
Refinance
Preview
Settled
Redemption
System
State
Trove
Trove
Amounts
Write
Diagnosis
Write
Result
Type Aliases
Adjust
Block
Reason
Borrow
Block
Reason
Close
Block
Reason
Entire
Debt
And
Coll
Fixed
Constants
Gas
Decision
Musd
Addresses
Musd
Constants
Musd
Contract
Name
Musd
Error
Code
Open
Block
Reason
Redeem
Block
Reason
Refinance
Block
Reason
Supported
Chain
Id
Trove
Status
Write
Failure
Kind
Variables
ALL_
MUSD_
ERROR_
CODES
BPS_
DIVISOR
CCR
DECIMAL_
PRECISION
DEFAULT_
CONSTANTS_
TTL_
MS
DEFAULT_
GAS_
MARGIN_
PERCENT
DEFAULT_
HINT_
RANDOM_
SEED
DEFAULT_
REDEMPTION_
MAX_
ITERATIONS
FIXED_
CONSTANTS
MCR
MIN_
NET_
DEBT_
MIN
MULTICALL3_
ADDRESS
MUSD_
CONTRACT_
NAMES
MUSD_
GAS_
COMPENSATION
Musd
Error
Code
NICR_
PRECISION
ONE_
HUNDRED_
PCT
PERCENT_
DIVISOR
REDEMPTION_
ADVICE_
MARGIN_
SECONDS
REDEMPTION_
PRICE_
MOVE_
TOLERANCE
REDEMPTION_
SEND_
MARGIN_
SECONDS
SECONDS_
PER_
YEAR
SUPPORTED_
CHAIN_
IDS
Trove
Status
Functions
accrued
Interest
capacity
After
Adjustment
compute
Entire
Debt
compute
Hints
computeICR
compute
Liquidation
Price
compute
Max
Withdrawable
computeNICR
create
Contracts
create
Musd
Client
diagnose
Reverted
Write
draw
For
Margin
effective
Borrowing
Fee
estimate
Collateral
Drawn
evaluate
Adjust
evaluate
Borrow
evaluate
Close
evaluate
Open
evaluate
Redeem
evaluate
Refinance
exceeds
Rate
Cap
format
Btc
format
Musd
get
Addresses
get
Borrowing
Capacity
get
Borrowing
Power
get
Health
Factor
has
Address
Override
is
Borrowing
Fee
Charged
is
Supported
Chain
Id
is
Trove
Liquidatable
map
Revert
max
Borrowing
Capacity
At
max
Withdrawable
Collateral
net
Debt
Of
parse
Bps
parse
Btc
parse
Musd
partial
Redemption
Band
preview
Adjust
Trove
preview
Borrow
preview
Close
preview
Open
preview
Redeem
preview
Refinance
preview
Withdraw
Collateral
revert
Reason
settled
Redemption
From
trials
For
Size
trove
Amounts
with
Gas
Margin
musd-kit API reference
Loading...